diff --git a/README.md b/README.md index 39cfda9..01171b0 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,13 @@ Fully managed hosting of your personal Haven is available too, check out: https: ## Docker +1. Install `docker` and `docker-compose` + If you don't know how to install `docker` and `docker-compose`, you can find info in [introduction to docker](https://fullstackopen.com/en/part12/introduction_to_containers#installing-everything-required-for-this-part) , [overview of installing docker compose](https://docs.docker.com/compose/install/) and [get docker desktop](https://docs.docker.com/get-docker/). + +2. Clone the repository: `git clone https://github.com/havenweb/haven.git` +3. Run `cd haven` +4. Run `docker compose up` + Feel free to use the included `Dockerfile` and `docker-compose.yml`. You probably want to modify the env vars in `docker-compose.yml` to specify a different `HAVEN_USER_EMAIL` and `HAVEN_USER_PASS`. These will be used to create you initial user (and password) on startup. Docker images are published to the [GitHub Container Registry](https://github.com/havenweb/haven/pkgs/container/haven)