Skip to main content

Before you start

Make sure your server meets these requirements before running the installer. The installer checks all of these automatically and will tell you if something is missing.
The 4 GB minimum assumes live collaboration is on (the default). It runs one extra service, the collaboration relay. If you turn collaboration off, 2 GB is enough for a small install. See Sizing & scaling to match resources to your team.
macOS and Windows are supported for testing and local use. On Windows, use Docker Desktop with WSL2.

How many users does it support?

These numbers apply to the current Beta and Release Candidate. They will be updated before general availability.
Collabase is optimized out of the box. You do not need to tune anything for the numbers below.
The number of registered accounts has no impact on performance. What matters is how many people are actively using the app at the same moment. To match RAM and CPU to that number — and to spread Collabase across separate servers as you grow — see Sizing & scaling.

Installation

You will have received a deployment ZIP from Collabase. Copy it to your server and unzip it.
Then run the installer:
The installer will ask you four questions:
The database password is used internally by Collabase and is never entered in the app itself. It does not need to be memorable — a password manager entry works well.
After you confirm, the installer downloads all required components and starts Collabase. This typically takes 2–5 minutes depending on your internet connection. Once it finishes, you will see a confirmation message with your URL. Open it in your browser and log in.
If your URL is a real domain (e.g. https://collabase.yourcompany.com), HTTPS is set up automatically. No certificate configuration is needed.
AI features (the CollabaseAI assistant, writing assistance, AI automation) use the AI provider you configure after installation under Settings → AI settings → Language model — for example OpenAI, Anthropic, or your own Ollama server. They do not need extra server RAM.

First login

Log in with the admin email and password you set during installation. You will be asked to choose a new password on first login. After that, you can:
  • Go to Admin → Users to invite your team
  • Create your first Space for a project or department
  • Explore the settings under Admin to configure authentication, email, and more

Updating Collabase

To update to a new version, run:
The update script backs up your database, downloads the latest version, and restarts everything automatically. You do not need to touch any configuration files.
Do not run install.sh again on an existing installation. Use update.sh for all updates.

Changing your URL or admin settings

If you need to change the URL or other settings configured during installation:
Your data is not affected — only the configuration is updated.

Managing your installation

The install script doubles as a management tool. Run it with a command: Before an update you can preview what would happen without changing anything:
Updates can be pinned to a specific version and undone:

Troubleshooting

Collabase did not start

The first start takes a little longer than usual — up to 3 minutes. If it still does not respond after that, check the logs:

Port 80 or 443 is already in use

Something else on your server is using a required port. Find it and stop it, then run the installer again:

CollabaseAI is not available

AI features need an AI provider to be configured. Go to Settings → AI settings → Language model, choose a provider (for example OpenAI or your own Ollama server), enter its access key, and click Save and test. Reload the page afterwards, because the assistant launcher is only drawn once the setting has reached the browser. If the test succeeds and the assistant still does not work, contact Collabase support.

I need help

Open a support ticket or submit a question at collabase.featurebase.app.
Last modified on July 30, 2026