diff --git a/README.md b/README.md index fda55a2..3c60085 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Docker container for [The Lounge](https://thelounge.github.io/), a self-hosted w ## Running a container -Using the example docker-compose.yml file +Using the example [`docker-compose.yml`](https://github.com/thelounge/docker-lounge/blob/master/docker-compose.yml) file. [What is docker-compose?](https://docs.docker.com/compose/) ```sh $ docker-compose up --detach ``` @@ -20,7 +20,20 @@ $ docker run --detach \ thelounge/lounge:latest ``` -## Environment variables +## Changing the port that The Lounge will be available on + +To change the port which The Lounge will be available on, one will have to +change the host port in the port mapping. To make The Lounge available on e.g. port 5000; +```sh +$ docker run --detach \ + --name lounge \ + --publish 5000:9000 \ # Change host port to listen on port 5000 + --volume ~/.lounge:/home/lounge/data \ + --restart always \ + thelounge/lounge:latest +``` + +## Environment variables (advanced usage) You can control how The Lounge is started through the following environment variables;