Service: Penpot - EyevinnOSC/community GitHub Wiki
Penpot (serviceId penpot-penpot) is an open-source design tool for teams. It runs in the browser and supports vector design, prototyping and developer handoff, similar to Figma. Files are stored as open SVG-based formats with no vendor lock-in. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: MPL-2.0.
- Create vector designs and prototypes in the browser.
- Collaborate in real time with teammates and invite them to teams.
- Share design specs with developers using View Mode and the Inspect panel.
- Be used from the Penpot desktop app by pointing it to your instance.
Penpot needs two dependencies. Create them first and confirm both are running:
-
PostgreSQL (serviceId
birme-osc-postgresql), where Penpot stores projects, files, users and teams. -
Valkey (serviceId
valkey-io-valkey), a Redis-compatible store used for real-time collaboration, caching and session management.
Read the address and port of each with describe-service-instance, and store the URLs as secrets with create-service-secret (serviceId: "penpot-penpot"), for example dburl (postgresql://<host>:<port>/<database>), dbpassword and redisurl (redis://:<password>@<host>:<port>). Then create Penpot with create-service-instance using serviceId: "penpot-penpot". The instance name must be alphanumeric and at most 20 characters.
{
"name": "mypenpot",
"DbUrl": "{{secrets.dburl}}",
"DbUsername": "postgres",
"DbPassword": "{{secrets.dbpassword}}",
"RedisUrl": "{{secrets.redisurl}}"
}Wait for the instance with wait-for-service-ready and get its URL with describe-service-instance.
With the OSC CLI:
osc create penpot-penpot mypenpot \
-o DbUrl="postgresql://host:5432/db" \
-o DbUsername="postgres" \
-o DbPassword="{{secrets.penpot-db-password}}" \
-o RedisUrl="<redis-url>"| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric, at most 20 characters. |
| DbUrl | Yes | string, sensitive | Connection URI of the PostgreSQL database where Penpot stores all application data (projects, files, users, teams), for example postgresql://host:5432/db. Store it as a secret and pass {{secrets.NAME}}. |
| DbUsername | Yes | string | Username for the PostgreSQL database in DbUrl. It needs permission to create, read, update and delete data in the Penpot schema. |
| DbPassword | No | string, sensitive | Password for DbUsername. Store it as a secret and pass {{secrets.NAME}}. Needed unless the database does not require a password. |
| RedisUrl | Yes | string, sensitive | Connection URI of the Redis-compatible instance (Valkey) used for real-time collaboration, caching and sessions, in the format redis://:<password>@<host>:<port>. Store the whole URL as a secret and pass {{secrets.NAME}}; a secret reference cannot be embedded inside a longer value. |
DbUrl, DbPassword and RedisUrl are sensitive. A {{secrets.NAME}} reference must be the whole field value, and changing a secret later does not restart a running instance.
- Open the instance URL and register a new account. Penpot has no pre-set admin credentials; the first user to register gets admin privileges.
- Create a project, invite teammates from Team Settings, and share design specs with developers using View Mode or the Inspect panel.
- Desktop app: in Penpot Desktop choose "Use custom server" on the login screen and enter your OSC instance URL.
- Storage is limited to 10 GiB per instance.
- Both a PostgreSQL and a Valkey instance are required.