Skip to content

Commit

Permalink
Merge pull request #1 from lildude/new-repo
Browse files Browse the repository at this point in the history
Point to new repo
  • Loading branch information
lildude authored Mar 29, 2024
2 parents e469bff + 86c74e0 commit 04afba3
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 31 deletions.
2 changes: 1 addition & 1 deletion .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
20 changes: 0 additions & 20 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
[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
2 changes: 1 addition & 1 deletion build.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
4 changes: 2 additions & 2 deletions config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -37,5 +37,5 @@
"jwt_secret_key": "str?"
},
"codenotary": "[email protected]",
"image": "ghcr.io/lildude/ghostfolio-{arch}"
"image": "ghcr.io/lildude/ha-addon-ghostfolio/ghostfolio-{arch}"
}

0 comments on commit 04afba3

Please sign in to comment.