https://github.com/arthurfdlr/fava-service
💸 Deploy Beancount Fava as a Docker service with authentication, dark theme, and auto refresh
https://github.com/arthurfdlr/fava-service
beancount docker ledger plaintext-accounting
Last synced: 7 months ago
JSON representation
💸 Deploy Beancount Fava as a Docker service with authentication, dark theme, and auto refresh
- Host: GitHub
- URL: https://github.com/arthurfdlr/fava-service
- Owner: ArthurFDLR
- Created: 2023-09-06T04:38:20.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-07T15:46:01.000Z (about 2 years ago)
- Last Synced: 2025-01-14T22:31:37.993Z (9 months ago)
- Topics: beancount, docker, ledger, plaintext-accounting
- Language: CSS
- Homepage:
- Size: 85 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Beancount Fava Docker Service
Deploy [Beancount Fava](https://github.com/beancount/fava) as a Docker service, including:
- Automatic refresh of your Ledger hosted on a Git repository;
- [Nginx](https://www.nginx.com/) reverse proxy with [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication);
- [Nord Theme](https://www.nordtheme.com/) for Fava;
## Installation
### Build the Docker image
1. Set the port for the Fava service in the [`nginx.conf`](./nginx.conf) file (`80` by default):
```nginx.conf
...
server {
listen 80;
...
```
2. Set new credentials (User: `admin` & Password: `admin` by default):
```sh
htpasswd -c .htpasswd
```
> **Note:** Install `apache2-utils` if you don't have `htpasswd`.
3. Set the refresh rate of the Ledger (i.e. `pull` your repository) as a Cron schedule in the [`Dockerfile`](./Dockerfile) file (`0 * * * *` by default).
4. [Optional] Customize the Fava theme by editing the [`style.css`](./style.css) file ([Nord Theme](https://www.nordtheme.com/) by default). Or, if you want to use the default Fava theme, comment the following line in the [`Dockerfile`](./Dockerfile) file:
```Dockerfile
# Comment the following line to use the default Fava theme
COPY ./style.css ./fava/frontend/css/style.css
```
5. Build the Docker image:
```sh
docker build -t fava-service .
```
> **Note:** You can change the name of the image (`fava-service`) to whatever you want.
### Run the Docker container
1. Set the URL to your Ledger repository as (1.) an environment variable, **OR** (2.) a Docker secret:
1. Set `REPOSITORY_URL` to the URL of your Ledger repository in [`example/user.conf`](./example/user.conf):
```sh
echo "REPOSITORY_URL=https://git.server/ledger.git" >> ./example/user.conf
```
2. Update [`example/ledger-git`](`./example/ledger-git`) to use the URL of your Ledger repository:
```sh
echo -n "https://:@git.server/ledger.git" > ./example/ledger-git
```
> **Note:** The environment variable `REPOSITORY_URL` has priority over the Docker secret `ledger-git` if both are set.
2. Set `BEAN_FILE` to the path of your main Beancount file in your Ledger repository in [`example/user.conf`](./example/user.conf). Do not use trailing slashes. For example:
```sh
echo "BEAN_FILE=main.beancount" >> ./example/user.conf
echo "BEAN_FILE=my-ledger/main.beancount" >> ./example/user.conf
```
3. Start the Docker service:
```sh
docker compose -f example/docker-compose.yml up
```