diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index b9ea271..f842b7b 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,5 +1,5 @@ { - "name": "lildude's Home Assistant Add-on Repo", + "name": "HA Addon: Ghostfolio", "image": "ghcr.io/home-assistant/devcontainer:addons", "appPort": ["7123:8123", "7357:4357"], "postStartCommand": "bash devcontainer_bootstrap", diff --git a/DOCS.md b/DOCS.md index 1bbb6cf..204095e 100644 --- a/DOCS.md +++ b/DOCS.md @@ -6,25 +6,6 @@ Manage your wealth like a boss. This addon allows you to run [Ghostfolio][] on your Home Assistant server based on the the official Ghostfolio [docker image][]. -## 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. - -## Installation - -The installation of this add-on is pretty straightforward and no different to installing any other Home Assistant add-on. - -1. Click the Home Assistant My button below to open the add-on 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) - -1. Install 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. - ## Configuration The configuration is self-explanatory, but essentially we need details about accessing the PostgreSQL database. @@ -55,4 +36,3 @@ As all the information is stored in the PostgreSQL database, this data will pers [Ghostfolio]: https://ghostfol.io [docker image]: https://hub.docker.com/r/ghostfolio/ghostfolio -[PostgreSQL add-on]: https://github.com/matt-FFFFFF/hassio-addon-postgres diff --git a/README.md b/README.md index 4ea006c..4dd594f 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,37 @@ This addon allows you to run [Ghostfolio][] on your Home Assistant server based [![Sponsor me to maintain this addon](https://img.shields.io/badge/Sponsor_Me-%E2%9D%A4-ec6cb9?logo=GitHub)](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 Architecture](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](https://img.shields.io/badge/dynamic/json?label=Ghostfolio%20Version&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addons%2Fmain%2Fghostfolio%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-addons%2Fmain%2Fghostfolio%2Fconfig.json) -![Supported Architecture](https://img.shields.io/badge/dynamic/json?color=green&label=Arch&query=%24.arch&url=https%3A%2F%2Fraw.githubusercontent.com%2Flildude%2Fha-addons%2Fmain%2Fghostfolio%2Fconfig.json) +| 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](https://raw.githubusercontent.com/lildude/ha-addons/main/ghostfolio/imgs/screenshot-light.png) | ![Dark screenshot](https://raw.githubusercontent.com/lildude/ha-addons/main/ghostfolio/imgs/screenshot-dark.png) | +## 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. + +For convenience, my [add-ons repository][] includes configuration that points to the [PostgreSQL add-on][] 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. + + [![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) + +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 \ No newline at end of file +[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 diff --git a/build.json b/build.json index 53e53e6..86f47db 100644 --- a/build.json +++ b/build.json @@ -10,7 +10,7 @@ "labels": { "org.opencontainers.image.title": "Home Assistant Add-on: Ghostfolio", "org.opencontainers.image.description": "Privacy-first, open source dashboard for your personal finances.", - "org.opencontainers.image.source": "https://github.com/lildude/ha-addons/", + "org.opencontainers.image.source": "https://github.com/lildude/ha-addon-ghostfolio/", "org.opencontainers.image.licenses": "MIT" }, "codenotary": { diff --git a/config.json b/config.json index 7768e99..c71b236 100644 --- a/config.json +++ b/config.json @@ -3,7 +3,7 @@ "version": "1.0.0", "slug": "ghostfolio", "description": "Privacy-first, open source dashboard for your personal finances.", - "url": "https://github.com/lildude/ha-addons/tree/main/ghostfolio", + "url": "https://github.com/lildude/ha-addon-ghostfolio/tree/main/ghostfolio", "arch": [ "armv7", "aarch64", @@ -37,5 +37,5 @@ "jwt_secret_key": "str?" }, "codenotary": "colin@symr.io", - "image": "ghcr.io/lildude/ghostfolio-{arch}" + "image": "ghcr.io/lildude/ha-addon-ghostfolio/ghostfolio-{arch}" } \ No newline at end of file