diff --git a/README.md b/README.md index eb1bcc3b..8ec1c6e7 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ If you find this interesting, come and discuss on [`#hydrogen:matrix.org`](https # How to use -Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. +Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. If you prefer, you can also [use docker](doc/docker.md). # FAQ diff --git a/doc/docker.md b/doc/docker.md new file mode 100644 index 00000000..92f33ae8 --- /dev/null +++ b/doc/docker.md @@ -0,0 +1,22 @@ +Usage of docker is a third-party contribution and not actively tested, used or supported by the main developer(s). + +Having said that, you can also use Docker to create a local dev environment. + +In this repository, create a Docker image: + + docker build -t hydrogen . + +Then start up a container from that image: + + docker run \ + --name hydrogen-dev \ + --publish 3000:3000 \ + --volume "$PWD":/code \ + --interactive \ + --tty \ + --rm \ + hydrogen + +Then point your browser to `http://localhost:3000`. You can see the server logs in the terminal where you started the container. + +To stop the container, simply hit `ctrl+c`.