Skip to content

Commit

Permalink
App Submission: Maybe (#1105)
Browse files Browse the repository at this point in the history
Co-authored-by: nmfretz <nmfretz@gmail.com>
  • Loading branch information
CaptainCodeman and nmfretz authored Jun 26, 2024
1 parent e70fb53 commit f61b89b
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 0 deletions.
Empty file added maybe/data/postgres/.gitkeep
Empty file.
Empty file added maybe/data/rails/.gitkeep
Empty file.
51 changes: 51 additions & 0 deletions maybe/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
version: '3.7'

services:
app_proxy:
environment:
APP_HOST: maybe_web_1
APP_PORT: 3063

web:
image: ghcr.io/maybe-finance/maybe:0.1.0-alpha.7@sha256:ea5897545aaea97e80de7f6ccafe953ad55e9a766070383215a693a9f85f12e0
restart: on-failure
stop_grace_period: 1m
volumes:
- ${APP_DATA_DIR}/data/rails:/rails/storage
# Self-hosted Maybe requires a Synth API key (https://synthfinance.com/) for basic multi-currency support.
# Ideally Maybe will support API key input via the UI in the future, but for now we create a persistent .env file for Advanced users to input their API key and restart Maybe (see pre-install hook)
env_file:
- ${APP_DATA_DIR}/.env
environment:
SELF_HOSTING_ENABLED: "true"
PORT: 3063
DB_HOST: db
DB_PORT: 5432
DATABASE_URL: postgres://maybe:maybe@db:5432/maybe
RAILS_FORCE_SSL: "false"
RAILS_ASSUME_SSL: "false"
POSTGRES_DB: maybe
POSTGRES_USER: maybe
POSTGRES_PASSWORD: maybe
GOOD_JOB_EXECUTION_MODE: async
SECRET_KEY_BASE: $APP_SEED
depends_on:
db:
condition: service_healthy

db:
image: postgres:16@sha256:1bf73ccae25238fa555100080042f0b2f9be08eb757e200fe6afc1fc413a1b3c
restart: on-failure
stop_grace_period: 1m
volumes:
- ${APP_DATA_DIR}/data/postgres:/var/lib/postgresql/data
environment:
POSTGRES_DB: maybe
POSTGRES_USER: maybe
POSTGRES_PASSWORD: maybe
PGDATA: /var/lib/postgresql/data/pgdata
healthcheck:
test: ['CMD-SHELL', 'pg_isready -U maybe']
interval: 10s
timeout: 5s
retries: 5
22 changes: 22 additions & 0 deletions maybe/hooks/pre-install
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/usr/bin/env bash
set -euo pipefail

# As of 26 June 2024, self-hosted Maybe requires a Synth API key (https://synthfinance.com/) for basic multi-currency support.
# Ideally Maybe will support API key input via the UI in the future, but for now we create a persistent .env file for Advanced users to input their API key and restart Maybe.

PERSISTENT_ENV_FILE="$(dirname "${BASH_SOURCE[0]}")/../.env"
DESIRED_OWNER="1000:1000"

create_env_file() {
cat <<EOF > "${PERSISTENT_ENV_FILE}"
# Uncomment the SYNTH_API_KEY line and replace YOUR_SYNTH_API_KEY with your personal Synth API key
# SYNTH_API_KEY=YOUR_SYNTH_API_KEY
EOF
chown "${DESIRED_OWNER}" "${PERSISTENT_ENV_FILE}"
}

if [[ ! -f "${PERSISTENT_ENV_FILE}" ]]; then
echo ".env file for Maybe has not been created yet. Creating one now..."
create_env_file
fi

39 changes: 39 additions & 0 deletions maybe/umbrel-app.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
manifestVersion: 1.1
id: maybe
category: finance
name: Maybe
version: 'v0.1.0-alpha.7'
tagline: The OS for your personal finances
description: >-
Maybe is a fully (your finances are secure) open-source OS for your personal finances built by
a small team alongside an incredible community.
This is an early access release of Maybe that is only available to those who self-host.
Maybe is under active development and is still working towards a stable release with a full feature set.
🛠️ MULTI-CURRENCY SUPPORT
Most currently available features will work out of the box. However, Maybe requires a Synth API key if you would like to use multi-currency support.
1. Sign up for a Synth API key at https://synthfinance.com/
2. Add your Synth API key to the .env file at ~/umbrel/app-data/maybe/.env
releaseNotes: ""
developer: Maybe
website: https://maybe.co/
dependencies: []
repo: https://github.com/maybe-finance
support: https://github.com/maybe-finance/discussions
port: 3063
gallery:
- 1.jpg
- 2.jpg
- 3.jpg
path: ''
defaultUsername: ''
defaultPassword: ''
submitter: CaptainCodeman
submission: https://github.com/getumbrel/umbrel-apps/pull/1105

0 comments on commit f61b89b

Please sign in to comment.