diff --git a/CHANGELOG b/CHANGELOG index 4bb40f3..d652b86 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,4 +1,4 @@ -2020-01-24 Version 2.8.0 (stable) +2020-01-25 Version 2.8.0 (stable) myrtille is now available as a docker image (see DOCUMENTATION.MD) resynced FreeRDP (among many things, fixes some issues related to the clipboard and audio) fixed session disconnect occuring under some circumstances on clipboard paste diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index cff93d7..ed2c874 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -62,24 +62,36 @@ No installation is required, you just need Docker Desktop or Toolbox for Windows Myrtille is fully functional as a container, but there are also some limitations (inherent to Windows containers): print and audio redirection (through RDP) is not supported at the moment (this may change into a future version). -You can pull it from Docker Hub with the following command (use a tag for a specific version, or latest otherwise): +You can pull it from Docker Hub with the following command (use a tag for a specific version, or latest otherwise)
+``` docker pull cedrozor/myrtille(:tag) +``` -To list the network adapters available to Docker: +To list the network adapters available to Docker
+``` docker network ls +``` -Run the image (in detached mode) and provide the resulting container a network adapter able to connect your hosts: -docker run -d --network="" cedrozor/myrtille(:tag) +Run the image in detached mode (optionally provide the resulting container a network adapter able to connect your hosts)
+``` +docker run -d (--network="") cedrozor/myrtille(:tag) +``` -To list the containers: +To list the containers
+``` docker ps -a +``` -To open a shell into a container (and be able to explore it, check its **ip address**, logs, etc.): +To open a shell into a container (and be able to explore it, check its **ip address**, logs, etc.)
+``` docker exec -it cmd docker exec -it powershell +``` -To stop a container +To stop a container
+``` docker stop +``` If you intend to have custom settings, manage your hosts or keep track of the logs, you will need to perform additional steps (**data persistence**). diff --git a/README.md b/README.md index 6f56bc1..efacb2f 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,15 @@ See DOCUMENTATION.md for more details. From version 2.8.0, Myrtille is available as a docker image. -You can pull it from Docker Hub with the following command (use a tag for a specific version, or latest otherwise): +You can pull it from Docker Hub with the following command (use a tag for a specific version, or latest otherwise)
+``` docker pull cedrozor/myrtille(:tag) +``` + +Run the image in detached mode (optionally provide the resulting container a network adapter able to connect your hosts)
+``` +docker run -d (--network="") cedrozor/myrtille(:tag) +``` See DOCUMENTATION.md for more details.