Regroup all editable files in one place

diff --git a/Dockerfile b/Dockerfile
index cd3ab118cc5e32906aef57a14312b63745b7af7a..c760fecb4417b6e6a3f29fd0f7c173b18f6cbf94 100644 (file)
--- a/Dockerfile
+++ b/Dockerfile
@@ -23,8 +23,9 @@ RUN addgroup -S ${GROUP} -g ${GID} && adduser -D -S -u ${UID} ${USER} ${GROUP} &
 
 COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist /www/
 COPY --chown=${USER}:${GROUP} entrypoint.sh /entrypoint.sh
+RUN mv /www/assets /www/default-assets
 
 USER ${USER}
 EXPOSE ${PORT}
-VOLUME [ "/www/config.yml", "/www/assets" ]
+VOLUME [ "/www/assets" ]
 ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]

diff --git a/Dockerfile.arm32v7 b/Dockerfile.arm32v7
index ef01d1fb2dbf1dc3ba5a21e0c30a743990d7a0fc..8dc3b1c04675e3790e9be3615980c0c2d9ee9a3b 100644 (file)
--- a/Dockerfile.arm32v7
+++ b/Dockerfile.arm32v7
@@ -33,8 +33,9 @@ RUN addgroup -S ${GROUP} -g ${GID} && adduser -D -S -u ${UID} ${USER} ${GROUP} &
 
 COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist /www/
 COPY --chown=${USER}:${GROUP} entrypoint.sh /entrypoint.sh
+RUN mv /www/assets /www/default-assets
 
 USER ${USER}
 EXPOSE ${PORT}
-VOLUME [ "/www/config.yml", "/www/assets" ]
+VOLUME [ "/www/assets" ]
 ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]

diff --git a/Dockerfile.arm64v8 b/Dockerfile.arm64v8
index 7899027743a20f9b55751457b98bf8d4c9a9742b..8a7e99f952bf02ae9b2905abafe6b12db7743e82 100644 (file)
--- a/Dockerfile.arm64v8
+++ b/Dockerfile.arm64v8
@@ -33,8 +33,9 @@ RUN addgroup -S ${GROUP} -g ${GID} && adduser -D -S -u ${UID} ${USER} ${GROUP} &
 
 COPY --from=build-stage --chown=${USER}:${GROUP} /app/dist /www/
 COPY --chown=${USER}:${GROUP} entrypoint.sh /entrypoint.sh
+RUN mv /www/assets /www/default-assets
 
 USER ${USER}
 EXPOSE ${PORT}
-VOLUME [ "/www/config.yml", "/www/assets" ]
+VOLUME [ "/www/assets" ]
 ENTRYPOINT ["/bin/sh", "/entrypoint.sh"]

diff --git a/README.md b/README.md
index 65ef9ab92fc21fe5fc1d088df9ecaf3249c9bdf4..f65b417af3dd0cbc16efc92358f43ec6f8cec004 100644 (file)
--- a/README.md
+++ b/README.md
@@ -38,31 +38,23 @@ ervices on hand, from a simple `yaml` configuration file.
 
 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**.
 
-For more information about the `config.yml` file see [configuration](docs/configuration.md) the section.
+See [documentation](docs/configuration.md) for information about the configuration (`assets/config.yml`) options.
 
 ### Using docker
 
 ```sh
-docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/local/assets/:/www/assets b4bz/homer:latest
+docker run -p 8080:8080 -v /your/local/assets/:/www/assets b4bz/homer:latest
 ```
 
-As a bind mount is used here, docker will not copy the initial content of the `assets` directory to the mounted directory. 
-You can initialise your assets directory with the content provided in this repository
-```sh
-cp -r /public/assets/* /your/local/assets/
-```
-
-**Alternatively** if you just want to provide images/icons without customizing the other files (app manifest & pwa icons), you can mount a custom directory in the `www` directory and use it in your `config.yml` for icons path.
-
 ### Using the release tarball (prebuilt, ready to use)
 
-Download and extract the latest the latest release (`homer.zip`) from the [release page](https://github.com/bastienwirtz/homer/releases), rename the `config.yml.dist` file to `config.yml`, and put it behind a webserver.
+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.
  
 ```sh
 wget https://github.com/bastienwirtz/homer/releases/latest/download/homer.zip
 unzip homer.zip
 cd homer
-cp config.yml.dist config.yml
+cp assets/config.yml.dist assets/config.yml
 npx serve # or python -m http.server 8010 or apache, nginx ...
 ```
 

diff --git a/docs/configuration.md b/docs/configuration.md
index a2469ed515c40374ad5ca00c736ca021261ef403..409db345f773d3a4e38c5c9c6cf7cb67733dd47b 100644 (file)
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,6 +1,6 @@
 ## Configuration
 
-Title, icons, links, colors, and services can be configured in the `config.yml` file (located in project root directory once built, or in the `public/` directory in developement mode), using [yaml](http://yaml.org/) format.
+Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in developement mode), using [yaml](http://yaml.org/) format.
 
 ```yaml
 ---

diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md
index 632b62dec6e4b79d651ed42eddcc0812790cb3f2..fda670daadcd0b066ff68c8a1a580f5b4adef221 100644 (file)
--- a/docs/tips-and-tricks.md
+++ b/docs/tips-and-tricks.md
@@ -74,7 +74,7 @@ Great if you have a lot of services or a lot of tags!
 
 Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesnt mean it cant be done!
 
-You can setup and use [Code-Server](https://github.com/cdr/code-server) to edit your config.yml file from anywhere!
+You can setup and use [Code-Server](https://github.com/cdr/code-server) to edit your `config.yml` file from anywhere!
 
 If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it.
 Simply pass your homer config directory as and extra -v parameter to your code-server container:

diff --git a/entrypoint.sh b/entrypoint.sh
index 7623322067fdf874375a9bee0cb77d7eb229a44f..0b7cd24ee0f788b524231a6c6bbc0b1f3012d360 100644 (file)
--- a/entrypoint.sh
+++ b/entrypoint.sh
@@ -1,6 +1,10 @@
 #!/bin/sh
 
-yes n | cp -i /www/config.yml.dist /www/config.yml
-while true; do echo n; done | cp -Ri /app/dist/www/assets /www/assets 2>/dev/null
+while true; do echo n; done | cp -Ri /www/default-assets/* /www/assets/
+
+# Ensure compatibility with previous version (config.yml was in the root directory)
+if [ -f "/www/config.yml" ]; then
+    yes n | cp -i /www/config.yml /www/assets
+fi
 
 darkhttpd /www/ --no-listing --port $PORT

diff --git a/public/config.yml.dist b/public/assets/config.yml.dist
similarity index 100%
rename from public/config.yml.dist
rename to public/assets/config.yml.dist

diff --git a/public/config.yml.dist.sample-sui b/public/assets/config.yml.dist.sample-sui
similarity index 100%
rename from public/config.yml.dist.sample-sui
rename to public/assets/config.yml.dist.sample-sui

diff --git a/src/App.vue b/src/App.vue
index 17c32143b44cc93d4740f2cd6fdb547e00f2e0f4..613c743716b58757becaa41e3a4b18b04a034e2a 100644 (file)
--- a/src/App.vue
+++ b/src/App.vue
@@ -156,7 +156,7 @@ export default {
     document.title = `${this.config.title} | ${this.config.subtitle}`;
   },
   methods: {
-    getConfig: function (path = "config.yml") {
+    getConfig: function (path = "assets/config.yml") {
       return fetch(path).then((response) => {
         if (!response.ok) {
           throw Error(response.statusText);