diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 9 insertions, 16 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,16 +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. | ||
| 85 | 86 | ||
| 86 | ## Host in subfolder | 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`). | ||
| 87 | 89 | ||
| 88 | If you would like to host Homer in a subfolder, for e.g. behind a reverse proxy, supply the name of subfolder by using the `SUBFOLDER` env var. | ||
| 89 | 90 | ||
| 90 | ### Using docker-compose | 91 | ### Using docker-compose |
| 91 | 92 | ||
| 92 | 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. |
| 93 | 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): |
| 94 | 95 | ||
| 95 | ```yaml | 96 | ```yaml |
| 96 | volumes: | 97 | volumes: |
| @@ -99,21 +100,13 @@ ports: | |||
| 99 | - 8080:8080 | 100 | - 8080:8080 |
| 100 | ``` | 101 | ``` |
| 101 | 102 | ||
| 102 | To launch container: | 103 | Then launch the container: |
| 103 | 104 | ||
| 104 | ```sh | 105 | ```sh |
| 105 | cd /path/to/docker-compose.yml | 106 | cd /path/to/docker-compose.yml/ |
| 106 | docker-compose up -d | 107 | docker-compose up -d |
| 107 | ``` | 108 | ``` |
| 108 | 109 | ||
| 109 | 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`: | ||
| 110 | |||
| 111 | ```yaml | ||
| 112 | environment: | ||
| 113 | - UID=1000 | ||
| 114 | - GID=1000 | ||
| 115 | ``` | ||
| 116 | |||
| 117 | ### Using the release tarball (prebuilt, ready to use) | 110 | ### Using the release tarball (prebuilt, ready to use) |
| 118 | 111 | ||
| 119 | 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. |