diff options
author | Bastien Wirtz <bastien.wirtz@gmail.com> | 2020-11-16 22:06:14 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-11-16 22:06:14 -0800 |
commit | a2e28229a90d3f1adb10cc256cc14b4d48d50c42 (patch) | |
tree | 0843266b36d9794e32142c0662ceae2aae59204c /README.md | |
parent | ade77e42578998abc44434c495b41bde37552fe0 (diff) | |
parent | 86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376 (diff) | |
download | homer-a2e28229a90d3f1adb10cc256cc14b4d48d50c42.tar.gz homer-a2e28229a90d3f1adb10cc256cc14b4d48d50c42.tar.zst homer-a2e28229a90d3f1adb10cc256cc14b4d48d50c42.zip |
Minor edits on readme and documentation
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -8,7 +8,7 @@ | |||
8 | </h1> | 8 | </h1> |
9 | 9 | ||
10 | <h4 align="center"> | 10 | <h4 align="center"> |
11 | A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple `yaml` configuration file. | 11 | A dead simple static <strong>HOM</strong>epage for your serv<strong>ER</strong> to keep your services on hand, from a simple <code>yaml</code> configuration file. |
12 | </h4> | 12 | </h4> |
13 | 13 | ||
14 | <p align="center"> | 14 | <p align="center"> |
@@ -44,7 +44,7 @@ | |||
44 | - [Getting started](#getting-started) | 44 | - [Getting started](#getting-started) |
45 | - [Configuration](docs/configuration.md) | 45 | - [Configuration](docs/configuration.md) |
46 | - [Tips & tricks](docs/tips-and-tricks.md) | 46 | - [Tips & tricks](docs/tips-and-tricks.md) |
47 | - [Roadmap](#roadmap) | 47 | - [Roadmap](#roadmap) |
48 | - [Development](docs/development.md) | 48 | - [Development](docs/development.md) |
49 | 49 | ||
50 | 50 | ||
@@ -52,7 +52,7 @@ | |||
52 | - [yaml](http://yaml.org/) file configuration | 52 | - [yaml](http://yaml.org/) file configuration |
53 | - Installable (pwa) | 53 | - Installable (pwa) |
54 | - Search | 54 | - Search |
55 | - Grouping | 55 | - Grouping |
56 | - Theme customization | 56 | - Theme customization |
57 | - Offline heathcheck | 57 | - Offline heathcheck |
58 | - keyboard shortcuts: | 58 | - keyboard shortcuts: |
@@ -70,7 +70,7 @@ See [documentation](docs/configuration.md) for information about the configurati | |||
70 | 70 | ||
71 | ### Using docker | 71 | ### Using docker |
72 | 72 | ||
73 | To launch container : | 73 | To launch container: |
74 | 74 | ||
75 | ```sh | 75 | ```sh |
76 | docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest | 76 | docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest |
@@ -81,7 +81,7 @@ Default assets will be automatically installed in the `/www/assets` directory. U | |||
81 | ### Using docker-compose | 81 | ### Using docker-compose |
82 | 82 | ||
83 | The `docker-compose.yml` file must be edited to match your needs. | 83 | The `docker-compose.yml` file must be edited to match your needs. |
84 | Set the port and volume (equivalent to -p and -v arguments) : | 84 | Set the port and volume (equivalent to `-p` and `-v` arguments): |
85 | 85 | ||
86 | ```yaml | 86 | ```yaml |
87 | volumes: | 87 | volumes: |
@@ -90,25 +90,25 @@ ports: | |||
90 | - 8080:8080 | 90 | - 8080:8080 |
91 | ``` | 91 | ``` |
92 | 92 | ||
93 | To launch container : | 93 | To launch container: |
94 | 94 | ||
95 | ```sh | 95 | ```sh |
96 | cd /path/to/docker-compose.yml | 96 | cd /path/to/docker-compose.yml |
97 | docker-compose up -d | 97 | docker-compose up -d |
98 | ``` | 98 | ``` |
99 | 99 | ||
100 | 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` : | 100 | 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`: |
101 | 101 | ||
102 | ```yaml | 102 | ```yaml |
103 | environment: | 103 | environment: |
104 | - UID=1000 | 104 | - UID=1000 |
105 | - GID=1000 | 105 | - GID=1000 |
106 | ``` | 106 | ``` |
107 | 107 | ||
108 | ### Using the release tarball (prebuilt, ready to use) | 108 | ### Using the release tarball (prebuilt, ready to use) |
109 | 109 | ||
110 | Download 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. | 110 | 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 webserver. |
111 | 111 | ||
112 | ```sh | 112 | ```sh |
113 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip | 113 | wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip |
114 | unzip homer.zip | 114 | unzip homer.zip |