diff options
author | Evan Steinkerchner <esteinkerchner@gmail.com> | 2022-04-22 18:56:25 -0400 |
---|---|---|
committer | Evan Steinkerchner <esteinkerchner@gmail.com> | 2022-04-22 18:56:25 -0400 |
commit | b82626bc6d50de8a76929832a0fb7e7ef836122b (patch) | |
tree | 6a2982ea3374e050db2b568b16cf1bda1e28b24a /docs/getting_started.md | |
parent | 2b53c1a82acc73a3f1d8b2ea0e55567f80c9120f (diff) | |
download | homer-b82626bc6d50de8a76929832a0fb7e7ef836122b.tar.gz homer-b82626bc6d50de8a76929832a0fb7e7ef836122b.tar.zst homer-b82626bc6d50de8a76929832a0fb7e7ef836122b.zip |
Added open props, changed lots of styles, scrapped home page
Diffstat (limited to 'docs/getting_started.md')
-rw-r--r-- | docs/getting_started.md | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/getting_started.md b/docs/getting_started.md index 2a123e2..397a16d 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md | |||
@@ -1,8 +1,10 @@ | |||
1 | Homer is a full static html/js dashboard, generated from the source in `/src` using webpack. It's meant to be served by an HTTP server, **it will not work if you open dist/index.html directly over file:// protocol**. | 1 | ## Using Docker |
2 | 2 | ||
3 | See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options. | 3 | 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 | ||
5 | need to worry about is your config file. | ||
4 | 6 | ||
5 | ## Using docker | 7 | ### docker |
6 | 8 | ||
7 | To launch container: | 9 | To launch container: |
8 | 10 | ||
@@ -16,7 +18,7 @@ docker run -d \ | |||
16 | 18 | ||
17 | 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" [...]`). | 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" [...]`). |
18 | 20 | ||
19 | ## Using docker-compose | 21 | ### docker-compose |
20 | 22 | ||
21 | The `docker-compose.yml` file must be edited to match your needs. | 23 | The `docker-compose.yml` file must be edited to match your needs. |
22 | Set the port and volume (equivalent to `-p` and `-v` arguments): | 24 | Set the port and volume (equivalent to `-p` and `-v` arguments): |
@@ -43,7 +45,9 @@ environment: | |||
43 | - GID=1000 | 45 | - GID=1000 |
44 | ``` | 46 | ``` |
45 | 47 | ||
46 | ## Using the release tarball (prebuilt, ready to use) | 48 | ## Shipping your own web server |
49 | |||
50 | ### Prebuilt release tarball | ||
47 | 51 | ||
48 | 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. | 52 | 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. |
49 | 53 | ||
@@ -55,7 +59,7 @@ cp assets/config.yml.dist assets/config.yml | |||
55 | npx serve # or python -m http.server 8010 or apache, nginx ... | 59 | npx serve # or python -m http.server 8010 or apache, nginx ... |
56 | ``` | 60 | ``` |
57 | 61 | ||
58 | ## Build manually | 62 | ### Building from source |
59 | 63 | ||
60 | ```sh | 64 | ```sh |
61 | # Using yarn (recommended) | 65 | # Using yarn (recommended) |