diff options
-rw-r--r-- | docs/getting_started.md | 55 |
1 files changed, 43 insertions, 12 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md index 397a16d..29746e8 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md | |||
@@ -4,6 +4,12 @@ The fastest and recommended way to get your Homer instance up and running is | |||
4 | with Docker. The Docker image comes with a web server built-in so that all you | 4 | with Docker. The Docker image comes with a web server built-in so that all you |
5 | need to worry about is your config file. | 5 | need to worry about is your config file. |
6 | 6 | ||
7 | Internally, the Docker image looks for the assets in the `/www/assets` directory | ||
8 | so you can bind a volume from your host machine to that directory in order to | ||
9 | modify and persist the configuration files. The web server serves the dashboard | ||
10 | on port 8080, but using a port binding will let you expose that to whatever | ||
11 | external port you like. | ||
12 | |||
7 | ### docker | 13 | ### docker |
8 | 14 | ||
9 | To launch container: | 15 | To launch container: |
@@ -11,23 +17,39 @@ To launch container: | |||
11 | ```sh | 17 | ```sh |
12 | docker run -d \ | 18 | docker run -d \ |
13 | -p 8080:8080 \ | 19 | -p 8080:8080 \ |
14 | -v </your/local/assets/>:/www/assets \ | 20 | -v </your/local/assets>:/www/assets \ |
15 | --restart=always \ | 21 | --restart=always \ |
16 | b4bz/homer:latest | 22 | b4bz/homer:latest |
17 | ``` | 23 | ``` |
18 | 24 | ||
19 | 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" [...]`). | 25 | Use `UID` and/or `GID` env var to change the assets owner: |
26 | |||
27 | ```sh | ||
28 | docker run -d \ | ||
29 | -p 8080:8080 \ | ||
30 | -v </your/local/assets>:/www/assets \ | ||
31 | -e "UID=1000" -e "GID=1000" \ | ||
32 | --restart=always \ | ||
33 | b4bz/homer:latest | ||
34 | ``` | ||
20 | 35 | ||
21 | ### docker-compose | 36 | ### docker-compose |
22 | 37 | ||
23 | The `docker-compose.yml` file must be edited to match your needs. | 38 | It is recommended to use docker-compose to manage your Docker containers, and |
24 | Set the port and volume (equivalent to `-p` and `-v` arguments): | 39 | below you can find a simple compose yaml file. Copy the contents into a |
40 | `docker-compose.yaml` and modify the volume binding to your desired directory to | ||
41 | get started: | ||
25 | 42 | ||
26 | ```yaml | 43 | ```yaml |
27 | volumes: | 44 | version: '3.3' |
28 | - /your/local/assets/:/www/assets | 45 | services: |
29 | ports: | 46 | homer: |
30 | - 8080:8080 | 47 | restart: always |
48 | volumes: | ||
49 | - /your/local/assets:/www/assets | ||
50 | ports: | ||
51 | - 8080:8080 | ||
52 | image: b4bz/homer | ||
31 | ``` | 53 | ``` |
32 | 54 | ||
33 | To launch container: | 55 | To launch container: |
@@ -37,12 +59,21 @@ cd /path/to/docker-compose.yml | |||
37 | docker-compose up -d | 59 | docker-compose up -d |
38 | ``` | 60 | ``` |
39 | 61 | ||
40 | 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`: | 62 | Use `UID` and/or `GID` env var to change the assets owner: |
41 | 63 | ||
42 | ```yaml | 64 | ```yaml |
43 | environment: | 65 | version: '3.3' |
44 | - UID=1000 | 66 | services: |
45 | - GID=1000 | 67 | homer: |
68 | restart: always | ||
69 | volumes: | ||
70 | - /your/local/assets:/www/assets | ||
71 | ports: | ||
72 | - 8080:8080 | ||
73 | environment: | ||
74 | - UID=1000 | ||
75 | - GID=1000 | ||
76 | image: b4bz/homer | ||
46 | ``` | 77 | ``` |
47 | 78 | ||
48 | ## Shipping your own web server | 79 | ## Shipping your own web server |