Service: Open Events - EyevinnOSC/community GitHub Wiki
Open Events (serviceId eyevinn-openevents) is an open source event management and ticketing platform. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT.
- Create events and sell tickets online, with multiple ticketing options, and manage attendees.
- Process payments with Stripe, including automated refund processing and VAT handling (25% included).
- Role-based access control for organizers (Organizer, Super Admin), with email/password login handled by NextAuth.js.
- Store event cover images, media uploads and speaker photos in S3-compatible storage.
- Send order confirmations, tickets and receipts by email through an SMTP service you configure.
Open Events needs a PostgreSQL database, S3-compatible storage and a Stripe account. Create the dependencies first and confirm they are running:
-
PostgreSQL (
birme-osc-postgresql, see Service: PostgreSQL): create an instance with a password and usedescribe-service-instancefor its address and port. The connection URL has the formpostgres://postgres:<password>@<host>:<port>/postgres. -
MinIO (
minio-minio, see Service: MinIO): create an instance, note the endpoint URL, access key and secret key, and create a bucket, for exampleevents-media. -
Stripe: copy the secret key and publishable key from the Stripe API Keys section, and create a webhook endpoint pointing to
https://<your-instance-url>/api/webhooks/stripe. Copy its webhook signing secret. The instance URL is known once the instance exists, so you may need to create the webhook after the first create. - Create service secrets with
create-service-secret(serviceIdeyevinn-openevents), for example:
| Secret name | Value |
|---|---|
dburl |
PostgreSQL connection URL |
nextauthsecret |
Random string, for example from openssl rand -base64 32
|
stripesk |
Stripe secret key |
stripewebhook |
Stripe webhook signing secret |
s3key |
MinIO access key ID |
s3secret |
MinIO secret access key |
- Create the instance with
create-service-instance,serviceId: "eyevinn-openevents". A{{secrets.NAME}}reference only works as the entire field value.
{
"name": "myevents",
"databaseUrl": "{{secrets.dburl}}",
"nextauthSecret": "{{secrets.nextauthsecret}}",
"stripeSecretKey": "{{secrets.stripesk}}",
"stripePublishableKey": "<stripe-publishable-key>",
"stripeWebhookSecret": "{{secrets.stripewebhook}}",
"s3Endpoint": "https://<your-minio-endpoint>",
"s3Region": "us-east-1",
"s3BucketName": "events-media",
"s3AccessKeyId": "{{secrets.s3key}}",
"s3SecretAccessKey": "{{secrets.s3secret}}",
"siteUrl": "https://<instance-url>"
}Use wait-for-service-ready or get-instance-status, then describe-service-instance for the instance URL. Set siteUrl to that URL (with update-service-instance if it was not known at creation).
With the OSC CLI:
npx -y @osaas/cli create eyevinn-openevents myevents \
-o databaseUrl="{{secrets.dburl}}" \
-o nextauthSecret="{{secrets.nextauthsecret}}" \
-o stripeSecretKey="{{secrets.stripesk}}" \
-o stripePublishableKey="<stripe-publishable-key>" \
-o stripeWebhookSecret="{{secrets.stripewebhook}}" \
-o s3Endpoint="https://myminio.minio-minio.auto.prod-se.osaas.io" \
-o s3Region="us-east-1" \
-o s3BucketName="events-media" \
-o s3AccessKeyId="{{secrets.s3key}}" \
-o s3SecretAccessKey="{{secrets.s3secret}}"| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| nextauthSecret | Yes | string, sensitive | Secret used by NextAuth.js to encrypt JWT tokens and session data. Used by the organizer login. |
| stripeSecretKey | Yes | string, sensitive | Stripe secret API key for online payments, refunds and VAT handling. |
| stripePublishableKey | Yes | string | Stripe publishable API key for the client-side payment form. Not sensitive. |
| stripeWebhookSecret | Yes | string, sensitive | Stripe webhook endpoint signing secret, used to verify payment event notifications (payment confirmations and automated refunds). |
| s3Endpoint | Yes | string | S3-compatible storage endpoint URL for uploads (event cover images, media and speaker photos). Works with MinIO on OSC. |
| s3Region | Yes | string | Region of the S3-compatible storage, for example us-east-1. |
| s3BucketName | Yes | string | Name of the existing bucket where uploaded files are stored. |
| s3AccessKeyId | Yes | string, sensitive | Access key ID for the storage. |
| s3SecretAccessKey | Yes | string, sensitive | Secret access key for the storage. |
| smtpHost | No | string | SMTP server hostname for sending email. Emails sent through OSC's default mail service are not delivered, so configure a third-party service (for example SendGrid, Postmark or AWS SES) for order confirmations, tickets and receipts. |
| smtpPort | No | string | SMTP server port, typically 587. |
| smtpUser | No | string | SMTP username. |
| smtpPassword | No | string, sensitive | SMTP password. |
| fromEmail | No | string | Sender address for outgoing email (order confirmations, tickets, receipts). Use an address on a reputable domain for deliverability. |
| siteName | No | string | Name of the platform displayed in the application. |
| siteUrl | No | string | Base URL of the deployed application, used to generate absolute URLs in emails and redirects. |
| databaseUrl | Yes | string, sensitive | PostgreSQL connection string for the database that stores events, orders, users and all platform data (accessed with Prisma). |
Store the sensitive options as secrets and pass them as {{secrets.NAME}}, as the entire field value.
Open the instance URL and register your first account. The first account created gets Super Admin privileges, which lets you manage all events and create additional organizer accounts.
- Without SMTP configured, order confirmation emails are not sent to attendees.