Getting Started

Vacay Planner is an open-source team vacation planning tool that provides a shared calendar for scheduling and managing time off. It features real-time updates and role-based access control. Available as a managed service on Eyevinn Open Source Cloud.

Prerequisites

Step 1: Create a CouchDB instance

Vacay Planner uses CouchDB for storing vacation data. Navigate to the CouchDB service page and click Create couchdb. Enter a name and an admin password, then click Create.

Once the instance is running, note the IP address and port from the instance card.

Step 2: Store the CouchDB connection URL as a secret

Build a full connection URL using the admin credentials:

http://admin:<password>@<IP>:<PORT>

For example:

http://admin:mypassword@172.232.131.169:10400

Navigate to the Vacay Planner service page, go to the Service Secrets tab, and click New Secret. Enter a name such as dburl and paste the full connection URL as the value.

Step 3: Generate a JWT secret

Vacay Planner requires a secret key for signing authentication tokens. Generate one with:

openssl rand -hex 32

Store this value as another service secret named jwtsecret.

Step 4: Create a Vacay Planner instance

Go to the My vacay-planners tab and click Create vacay-planner. Fill in:

  • Name: a unique name for your instance (alphanumeric only, e.g. myteamvacay)
  • DbUrl: {{secrets.dburl}}
  • JwtSecret: {{secrets.jwtsecret}}

Click Create and wait for the status indicator to turn green.

Step 5: Open the application

Click the instance URL to open Vacay Planner. Create your admin account and start inviting team members.

CLI usage

osc create birme-vacay-planner myteamvacay \
  -o DbUrl="{{secrets.dburl}}" \
  -o JwtSecret="{{secrets.jwtsecret}}"

Resources