Documentation and config improvements (#9)

* Remove changelog in favour of release notes

* Improve docs

* Use dev version

* Lock down access to ingress

DOCS.md

@@ -2,9 +2,10 @@
 
 Manage your wealth like a boss.
 
-[Ghostfolio][] is a privacy-first, open source dashboard for your personal finances. Break down your asset allocation, know your net worth and make solid, data-driven investment decisions.
+[Ghostfolio][ghostfolio] is a privacy-first, open source dashboard for your personal finances.
+Break down your asset allocation, know your net worth and make solid, data-driven investment decisions.
 
-This addon allows you to run [Ghostfolio][] on your Home Assistant server based on the the official Ghostfolio [docker image][].
+This addon allows you to run [Ghostfolio][ghostfolio] on your Home Assistant server based on the the official Ghostfolio [docker image][docker].
 
 ## Configuration
 
@@ -16,24 +17,42 @@ The configuration is self-explanatory, but essentially we need details about acc
 
 - `database_port`: The port your PostgreSQL server is listening on. Default: `5432`.
 
-- `database_host`: The hostname of your PostgreSQL server. Default: `29b65938-postgres` for the [PostgreSQL add-on][].
+- `database_host`: The hostname of your PostgreSQL server. Default: `29b65938-postgres` for the [PostgreSQL add-on][postgres].
 
 - `database_name`: The name of the PostgreSQL database to create and use. Default: `ghostfolio`.
 
 - `api_key_coingecko_demo`: (Optional) CoinGecko Demo API Key
 
 - `api_key_coingecko_pro`: (Optional) CoinGecko Pro API Key
 
-- `access_token_salt`: (Optional) A random string used as salt for access tokens. This will be auto-generated on first run if not set.
+- `access_token_salt`: (Optional) A random string used as salt for access tokens.
+  This will be auto-generated on first run if not set.
+
+- `jwt_secret_key`: (Optional) A random string used for JSON Web Tokens (JWT).
+  This will be auto-generated on first run if not set.
 
-- `jwt_secret_key`: (Optional) A random string used for JSON Web Tokens (JWT). This will be auto-generated on first run if not set.
 - `silent`: (Optional) Hide all output except errors in the log file. Default: `false`.
 
 Remember to restart the add-on when the configuration is changed.
 
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases] functionality.
+
+Releases are based on [Semantic Versioning][semver], and use the format of `MAJOR.MINOR.PATCH`.
+In a nutshell, the version will be incremented based on the following:
+
+- `MAJOR`: Incompatible or major changes.
+- `MINOR`: Backwards-compatible new features and enhancements.
+- `PATCH`: Backwards-compatible bugfixes and package updates.
+
 ## Additional Information
 
-As all the information is stored in the PostgreSQL database, this data will persist if you uninstall this add-on. To destroy this data, you'll need to either uninstall the PostgreSQL add-on or connect to the PostgreSQL server directly and drop the database.
+As all the information is stored in the PostgreSQL database, this data will persist if you uninstall this add-on.
+To destroy this data, you'll need to either uninstall the PostgreSQL add-on or connect to the PostgreSQL server directly and drop the database.
 
-[Ghostfolio]: https://ghostfol.io
-[docker image]: https://hub.docker.com/r/ghostfolio/ghostfolio
+[docker]: https://hub.docker.com/r/ghostfolio/ghostfolio
+[ghostfolio]: https://ghostfol.io
+[postgres]: https://github.com/matt-FFFFFF/hassio-addon-postgres
+[releases]: https://github.com/lildude/ha-addon-ghostfolio/releases
+[semver]: https://semver.org/spec/v2.0.0.html

README.md

@@ -4,43 +4,53 @@ Manage your wealth like a boss.
 
 ## About
 
-[Ghostfolio][] is a privacy-first, open source dashboard for your personal finances. Break down your asset allocation, know your net worth and make solid, data-driven investment decisions.
+[Ghostfolio][ghostfolio] is a privacy-first, open source dashboard for your personal finances.
+Break down your asset allocation, know your net worth and make solid, data-driven investment decisions.
 
-This addon allows you to run [Ghostfolio][] on your Home Assistant server based on the the official Ghostfolio [docker image][].
+This addon allows you to run [Ghostfolio][ghostfolio] on your Home Assistant server based on the the official Ghostfolio [docker image][docker].
 
-[![Sponsor me to maintain this addon](https://img.shields.io/badge/Sponsor_Me-%E2%9D%A4-ec6cb9?logo=GitHub)](https://github.com/sponsors/lildude)
+[![Sponsor me to maintain this addon][sponsor-badge]](https://github.com/sponsors/lildude)
 
-![Ghostfolio Version](https://img.shields.io/badge/dynamic/json?label=Ghostfolio%20Version&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-ghostfolio%2Fmain%2Fbuild.json&query=%24.args.ghostfolio_version)
-![Ingress](https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-ghostfolio%2Fmain%2Fconfig.json)
-![Supported Architectures](https://img.shields.io/badge/dynamic/json?color=green&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-ghostfolio%2Fmain%2Fconfig.json)
+![Ghostfolio Version][ghostfolio-version]
+![Ingress][ingres-badge]
+![Supported Architectures][archs]
 
-| Light Mode                                                                                                        | Dark Mode                                                                                                       |
-| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
-| ![Light screenshot](https://raw.githubusercontent.com/lildude/ha-addon-ghostfolio/main/imgs/screenshot-light.png) | ![Dark screenshot](https://raw.githubusercontent.com/lildude/ha-addon-ghostfolio/main/imgs/screenshot-dark.png) |
+| Light Mode                 | Dark Mode                |
+| -------------------------- | ------------------------ |
+| ![Light screenshot][light] | ![Dark screenshot][dark] |
 
 ## Requirements
 
-Ghostfolio needs a PostgreSQL database. All development and testing has been done using [PostgreSQL add-on][] for convenience but you're welcome to use your own.
+Ghostfolio needs a PostgreSQL database.
+All development and testing has been done using [PostgreSQL add-on][postgres] for convenience but you're welcome to use your own.
 
-For convenience, my [add-ons repository][] includes configuration that points to the [PostgreSQL add-on][] so you can install everything from one repo.
+For convenience, my [add-ons repository][addons-repo] includes configuration that points to the [PostgreSQL add-on][postgres] so you can install everything from one repo.
 
 ## Installation
 
 The installation of this add-on is pretty straightforward and no different to installing any other Home Assistant add-on.
 
-1. Add my [add-ons repository][] to Home Assistant or click the button below to open my add-on repository on your Home Assistant instance.
+1. Add my [add-ons repository][addons-repo] to Home Assistant or click the button below to open my add-on repository on your Home Assistant instance.
 
-   [![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Flildude%2Fha-addons)
+   [![Open add-on repo on your Home Assistant instance][repo-btn]][addon]
 
 1. Install this add-on.
 1. Install the PostgreSQL add-on and configure and start it, if you wish to use this add-on.
 1. Enter your PostgreSQL configuration information.
 1. Click the `Save` button to store your configuration.
 1. Start the add-on.
 1. Check the logs of the add-on to see if everything went well.
-1. Click the "OPEN WEB UI" button to open Studio Code Server.
-
-[Ghostfolio]: https://ghostfol.io
-[docker image]: https://hub.docker.com/r/ghostfolio/ghostfolio
-[PostgreSQL add-on]: https://github.com/matt-FFFFFF/hassio-addon-postgres
-[add-ons repository]: https://github.com/lildude/ha-addons
+1. Click the `OPEN WEB UI` button to open Studio Code Server.
+
+[addon]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Flildude%2Fha-addons
+[addons-repo]: https://github.com/lildude/ha-addons
+[archs]: https://img.shields.io/badge/dynamic/json?color=green&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-ghostfolio%2Fmain%2Fconfig.json
+[dark]: https://raw.githubusercontent.com/lildude/ha-addon-ghostfolio/main/imgs/screenshot-dark.png
+[docker]: https://hub.docker.com/r/ghostfolio/ghostfolio
+[ghostfolio-version]: https://img.shields.io/badge/dynamic/json?label=Ghostfolio%20Version&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-ghostfolio%2Fmain%2Fbuild.json&query=%24.args.ghostfolio_version
+[ghostfolio]: https://ghostfol.io
+[ingres-badge]: https://img.shields.io/badge/dynamic/json?label=Ingress&query=%24.ingress&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addon-ghostfolio%2Fmain%2Fconfig.json
+[light]: https://raw.githubusercontent.com/lildude/ha-addon-ghostfolio/main/imgs/screenshot-light.png
+[postgres]: https://github.com/matt-FFFFFF/hassio-addon-postgres
+[repo-btn]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
+[sponsor-badge]: https://img.shields.io/badge/Sponsor_Me-%E2%9D%A4-ec6cb9?logo=GitHub

config.json

@@ -1,6 +1,6 @@
 {
   "name": "Ghostfolio",
-  "version": "1.1.0",
+  "version": "dev",
   "slug": "ghostfolio",
   "description": "Privacy-first, open source dashboard for your personal finances.",
   "url": "https://github.com/lildude/ha-addon-ghostfolio",

rootfs/etc/nginx/conf.d/ghostfolio.conf

@@ -6,8 +6,8 @@ map $http_upgrade $connection_upgrade {
 server {
     server_name _;
     listen 8099 default_server;
-    # allow  172.30.32.2;
-    # deny   all;
+    allow  172.30.32.2;
+    deny   all;
 
     location / {
         absolute_redirect off;
@@ -24,7 +24,7 @@ server {
         proxy_set_header Origin "";
         proxy_set_header X-Real-IP $remote_addr;
 
-        proxy_pass http://localhost:3333/;
+        proxy_pass http://127.0.0.1:3333;
         proxy_redirect '/' $http_x_ingress_path/;
         proxy_set_header Accept-Encoding "";