# Outline on Unbroker

Fast, collaborative knowledge base and wiki for your team

Canonical URL: https://unbroker.cloud/templates/outline
Catalog revision: c4e9e9b65202d3133ced7e02671e3867a1c86d27

[Deploy Outline](https://app.unbroker.cloud/apps?template=outline)

[Template source](https://github.com/unbroker-app/unbroker-cloud-templates/tree/c4e9e9b65202d3133ced7e02671e3867a1c86d27/templates/outline)

## Plan requirements

Template container services, databases and persistent volumes require Pro. Resource usage is billed separately. Review the configuration and pricing before deploying.

[Pricing](https://unbroker.cloud/pricing)

## Deployment inputs

- **ADMIN_EMAIL** (required): Email of the first admin. You sign in with a link sent to this address.
- **ADMIN_NAME** (required): Name shown for that admin.
- **WORKSPACE_NAME** (required): Name of the workspace.
- **SMTP_HOST** (required): SMTP server that sends the sign-in emails, e.g. smtp.resend.com.
- **SMTP_PORT** (required): SMTP port. 587 (STARTTLS) or 465 (TLS).
- **SMTP_SECURE** (required): "true" for port 465 (TLS from the start), "false" for 587 (STARTTLS).
- **SMTP_USERNAME** (optional): SMTP username. Leave empty if the server needs no authentication.
- **SMTP_PASSWORD** (optional): SMTP password or API key.
- **SMTP_FROM_EMAIL** (required): Sender of the sign-in emails, e.g. Outline <wiki@yourdomain.com>. The domain must be verified with your provider.

## Deploy button

Add this to a README or website. It opens this template's deploy form in Unbroker Cloud.

```markdown
[![Deploy on Unbroker](https://unbroker.cloud/button.svg)](https://app.unbroker.cloud/apps?template=outline)
```

A fast, collaborative knowledge base for your team: nested documents,
real-time editing, Markdown shortcuts, search, and integrations with Slack,
Figma, Linear and more.

## What gets deployed

| Service | Image | Notes |
|---|---|---|
| **Outline** | `outlinewiki/outline:1.11.0` | Public. Migrations run on boot. Uploads on a 5 GB volume |
| **db** | PostgreSQL 16 | Internal. Documents, users, history |
| **redis** | Redis 7 | Internal. Real-time collaboration and background jobs |

## Before you deploy: email

Outline signs people in with a **link sent by email**, so it needs an SMTP
server. Any transactional provider works (Resend, Postmark, Amazon SES,
Mailgun, your own). Have the host, port, credentials, and a verified sender
address ready for the deploy form.

## After deploy

The template creates the workspace on first boot with the **admin email** from
the deploy form, so nobody else can claim it. Open your Outline URL, enter that
email, and click the link you receive.

Invite your team from **Settings → Members**. To sign in with Google, Slack,
Microsoft or any OIDC provider instead of email links, add that provider's
variables (see [Outline's docs](https://docs.getoutline.com/s/hosting/doc/authentication-7ViKRmRY5o)).

## Good to know

- If Outline rejects the admin email or workspace name, the container stops and
  logs why, so the "create workspace" page never sits open. Fix the value and
  redeploy.
- `ADMIN_EMAIL`, `ADMIN_NAME` and `WORKSPACE_NAME` are only used on first boot.
- No sign-in email? Check the Outline service's logs: SMTP errors show up there.
  Port 465 needs `SMTP_SECURE=true`; 587 needs `false`.

## Service configuration

- **db**: postgres. Private service. 1 GiB persistent storage.
- **redis**: redis. Private service. 1 GiB persistent storage.
- **Outline**: outlinewiki/outline:1.11.0. Public URL. 5 GiB persistent storage.

## Project links

- [Website](https://www.getoutline.com)
- [Source code](https://github.com/outline/outline)
- [Documentation](https://docs.getoutline.com/s/hosting)

## More templates

- [MailCheap](https://unbroker.cloud/templates/mailcheap): Newsletters where you pay for the emails you send, not for dormant subscribers
- [Memos](https://unbroker.cloud/templates/memos): Lightweight, privacy-first note-taking
- [Miniflux](https://unbroker.cloud/templates/miniflux): Minimalist, opinionated feed reader

[All templates](https://unbroker.cloud/templates)