Skip to content

Commit

Permalink
updated markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
cedrozor committed Jan 25, 2020
1 parent 83539e3 commit c39a1fb
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG
Original file line number Diff line number Diff line change
@@ -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
Expand Down
26 changes: 19 additions & 7 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br/>
```
docker pull cedrozor/myrtille(:tag)
```

To list the network adapters available to Docker:
To list the network adapters available to Docker<br/>
```
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="<network adapter>" cedrozor/myrtille(:tag)
Run the image in detached mode (optionally provide the resulting container a network adapter able to connect your hosts)<br/>
```
docker run -d (--network="<network adapter>") cedrozor/myrtille(:tag)
```

To list the containers:
To list the containers<br/>
```
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.)<br/>
```
docker exec -it <container ID> cmd
docker exec -it <container ID> powershell
```

To stop a container
To stop a container<br/>
```
docker stop <container ID>
```

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**).

Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br/>
```
docker pull cedrozor/myrtille(:tag)
```

Run the image in detached mode (optionally provide the resulting container a network adapter able to connect your hosts)<br/>
```
docker run -d (--network="<network adapter>") cedrozor/myrtille(:tag)
```

See DOCUMENTATION.md for more details.

Expand Down

0 comments on commit c39a1fb

Please sign in to comment.