Step 1 of 7

Basic Configuration

How will you access Oikos?

Domain or IP address

The address you'll use to open Oikos in your browser.

Port

Timezone

Step 2 of 7

Security Keys

These protect your session and encrypt the database. Store your .env file safely — losing these keys means losing access to your data.

Session Secret

Signs browser session cookies.

Database Encryption Key

Encrypts the SQLite database at rest.

Step 3 of 7

Weather Widget

Show live weather on your dashboard. Requires a free OpenWeatherMap API key.

Enable weather widget

Step 4 of 7

Calendar Sync

Connect Oikos to Google Calendar or Apple iCloud. Both optional — expand to configure.

Google Calendar Optional

Create OAuth credentials at console.cloud.google.com. Redirect URI:

Client ID

Client Secret

Apple iCloud CalDAV Optional

Create an app-specific password at appleid.apple.com.

Apple ID (email)

App-Specific Password

Step 5 of 7

Review

Check your settings before writing .env and starting the container.

Host

Port

Timezone

SESSION_SECRET

••••••••

DB_ENCRYPT_KEY

••••••••

Weather

Google Calendar

Apple CalDAV

Step 6 of 7

Starting Oikos

Pulling the image and starting the Docker container.

Starting container…

Step 7 of 7

Create Admin Account

Set up your first login. This account has full access to Oikos.

Username

3–64 characters: letters, numbers, . - _

Display Name

Password

Confirm Password

🎉

Oikos is ready!

Your family planner is running and your admin account is set up.

Open Oikos →