Back to all templates
OtterWiki logo

OtterWiki

Application256MB+ RAM

Lightweight Python and Flask wiki that uses Markdown and git for storage

applicationdocsotterwikiopen-sourceself-hosteddocker

Deploy OtterWiki in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select OtterWiki

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy OtterWiki on a VPS with Server Compass

Use the OtterWiki template in Server Compass to deploy a lightweight Markdown wiki backed by git storage, then verify the web UI in a browser.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating an OtterWiki app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for OtterWiki

Use the template picker search to find OtterWiki in the Server Compass template catalog.

Searching for OtterWiki in the Server Compass template picker
4
Step 4

Select the OtterWiki template

Choose the OtterWiki template. Server Compass fills the web service, host port mapping, and persistent wiki data volume.

OtterWiki template selected in Server Compass
5
Step 5

Review the OtterWiki settings

Confirm the app name and web UI port. In this run, the app was named otterwiki-demo and used host port 4111.

Reviewing OtterWiki project settings and compose service
6
Step 6

Deploy OtterWiki

Review the generated compose settings, confirm the OtterWiki web port is available, and click Deploy.

Reviewing OtterWiki web port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the OtterWiki image, starts the container, and verifies the stack.

Server Compass deploying the OtterWiki template on the VPS
8
Step 8

Confirm OtterWiki is running

After deployment finishes, return to the Apps tab and confirm the OtterWiki app is marked Running with its application URL available.

OtterWiki template running in the Server Compass Apps tab
9
Step 9

Open OtterWiki in the browser

Open the application URL in a browser. The OtterWiki page confirms the Markdown wiki service is reachable.

The deployed OtterWiki web UI loaded in a browser

After OtterWiki Opens

  • Register the first user immediately; that account becomes the admin.
  • Configure email and registration mode under Admin > Settings.
  • Create the first wiki page and confirm it is stored in the git-backed data volume.
  • Back up the OtterWiki data volume because it contains the wiki repository.

Verified Result

The OtterWiki web interface loaded successfully from the deployed container.

OtterWiki deployment questions

What does the OtterWiki template deploy?

It deploys the OtterWiki web app with a persistent git-backed data volume for Markdown wiki pages.

Which port did the tutorial use?

The tutorial used host port 4111, which maps to the OtterWiki web UI on container port 80.

Does OtterWiki need setup after deployment?

Yes. Register the first admin user, configure registration mode, and create the first page.

Should this become a blog post?

No. The deployment guide should live on the OtterWiki template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying OtterWiki with Server Compass, complete these steps to finish setup

1

Visit the application URL

2

Register the first user (becomes admin)

3

Configure email and registration mode under Admin > Settings

4

Create your first wiki page

Need help? Check out our documentation for detailed guides.

OtterWiki FAQ

Common questions about self-hosting OtterWiki

How do I deploy OtterWiki with Server Compass?

Simply download Server Compass, connect to your VPS, and select OtterWiki from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for OtterWiki?

OtterWiki requires a minimum of 256MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing OtterWiki data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard OtterWiki backup and restore procedures.

How do I update OtterWiki to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest OtterWiki image will be pulled and deployed with zero downtime.

Is OtterWiki free to self-host?

OtterWiki is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host OtterWiki?

Download Server Compass and deploy OtterWiki to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass