aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2020-08-28 23:12:22 -0700
committerGitHub <noreply@github.com>2020-08-28 23:12:22 -0700
commitdb738288fa7c99a3d5aa47f35a634297c7b1f506 (patch)
treea53625a19ce7d9106dec46bf599c04e54b4414e1 /README.md
parent154e6efe8036dca91b1bfe9c4fb22ef227df5858 (diff)
parente4537f134b02966e98b30520563395e17a1afe78 (diff)
downloadhomer-db738288fa7c99a3d5aa47f35a634297c7b1f506.tar.gz
homer-db738288fa7c99a3d5aa47f35a634297c7b1f506.tar.zst
homer-db738288fa7c99a3d5aa47f35a634297c7b1f506.zip
Merge pull request #101 from simonporte/master
Added docker-compose.yml
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index 33a15b1..b965f9b 100644
--- a/README.md
+++ b/README.md
@@ -70,12 +70,41 @@ See [documentation](docs/configuration.md) for information about the configurati
70 70
71### Using docker 71### Using docker
72 72
73To launch container :
74
73```sh 75```sh
74docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest 76docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest
75``` 77```
76 78
77Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`). 79Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner (`docker run -e "UID=1000" -e "GID=1000" [...]`).
78 80
81### Using docker-compose
82
83The `docker-compose.yml` file must be edited to match your needs.
84Set the port and volume (equivalent to -p and -v arguments) :
85
86```yaml
87volumes:
88 - /your/local/assets/:/www/assets
89ports:
90 - 8080:8080
91```
92
93To launch container :
94
95```sh
96cd /path/to/docker-compose.yml
97docker-compose up -d
98```
99
100Default assets will be automatically installed in the `/www/assets` directory. Use `UID` and/or `GID` env var to change the assets owner, also in `docker-compose.yml` :
101
102```yaml
103environment:
104- UID=1000
105- GID=1000
106```
107
79### Using the release tarball (prebuilt, ready to use) 108### Using the release tarball (prebuilt, ready to use)
80 109
81Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver. 110Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `assets/config.yml.dist` file to `assets/config.yml`, and put it behind a webserver.