diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 25 |
1 files changed, 11 insertions, 14 deletions
@@ -71,8 +71,6 @@ See [documentation](docs/configuration.md) for information about the configurati | |||
71 | 71 | ||
72 | ### Using docker | 72 | ### Using docker |
73 | 73 | ||
74 | To launch container: | ||
75 | |||
76 | ```sh | 74 | ```sh |
77 | docker run -d \ | 75 | docker run -d \ |
78 | -p 8080:8080 \ | 76 | -p 8080:8080 \ |
@@ -81,12 +79,19 @@ docker run -d \ | |||
81 | b4bz/homer:latest | 79 | b4bz/homer:latest |
82 | ``` | 80 | ``` |
83 | 81 | ||
84 | Default 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" [...]`). | 82 | Environment variables: |
83 | |||
84 | * **`INIT_ASSETS`** (default: `1`) | ||
85 | Install exemple configuration file & assets (favicons, ...) to help you get started. | ||
86 | |||
87 | * **`SUBFOLDER`** (default: `null`) | ||
88 | If you would like to host Homer in a subfolder, (ex: *http://my-domain/**homer***), set this to the subfolder path (ex `/homer`). | ||
89 | |||
85 | 90 | ||
86 | ### Using docker-compose | 91 | ### Using docker-compose |
87 | 92 | ||
88 | The `docker-compose.yml` file must be edited to match your needs. | 93 | The `docker-compose.yml` file must be edited to match your needs. |
89 | Set the port and volume (equivalent to `-p` and `-v` arguments): | 94 | You probably want to set the port mapping and volume binding (equivalent to `-p` and `-v` arguments): |
90 | 95 | ||
91 | ```yaml | 96 | ```yaml |
92 | volumes: | 97 | volumes: |
@@ -95,21 +100,13 @@ ports: | |||
95 | - 8080:8080 | 100 | - 8080:8080 |
96 | ``` | 101 | ``` |
97 | 102 | ||
98 | To launch container: | 103 | Then launch the container: |
99 | 104 | ||
100 | ```sh | 105 | ```sh |
101 | cd /path/to/docker-compose.yml | 106 | cd /path/to/docker-compose.yml/ |
102 | docker-compose up -d | 107 | docker-compose up -d |
103 | ``` | 108 | ``` |
104 | 109 | ||
105 | Default 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`: | ||
106 | |||
107 | ```yaml | ||
108 | environment: | ||
109 | - UID=1000 | ||
110 | - GID=1000 | ||
111 | ``` | ||
112 | |||
113 | ### Using the release tarball (prebuilt, ready to use) | 110 | ### Using the release tarball (prebuilt, ready to use) |
114 | 111 | ||
115 | Download and extract 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 web server. | 112 | Download and extract 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 web server. |