Skip to main content

Before you start

Make sure your server meets these requirements before running the installer.
Minimum
Operating systemUbuntu 22.04+, Debian 12+, or RHEL 9+
RAM2 GB — 4 GB recommended (required for the AI features)
Disk space20 GB free
DockerVersion 24 or later
Ports80 and 443 must not be in use by another service
The installer checks all of these automatically and will tell you if something is missing.
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.
Your team sizeWhat to expect
Up to 1,000 usersRuns comfortably on a minimum-spec server
1,000–2,000 usersRuns well, no changes needed
2,000–6,000 usersWorks — consider setting up monitoring
6,000+ usersContact Collabase for a scaling consultation
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.

Installation

You will have received a deployment ZIP from Collabase. Copy it to your server and unzip it.
unzip collabase-deployment.zip
cd deployment
Then run the installer:
bash install.sh
The installer will ask you three questions:
QuestionWhat to enter
Your URLThe address where Collabase will be accessible, e.g. https://collabase.yourcompany.com
Admin emailThe email address for the initial admin account
Admin passwordChoose a secure password (at least 8 characters)
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.
If your server has less than 4 GB of RAM, the AI features (Brain) will not be available. All other features — wiki, tasks, test management, automation — work normally.

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:
bash deployment/update.sh
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:
bash deployment/install.sh --reconfigure
Your data is not affected — only the configuration is updated.

Useful commands

# Check if all services are running
docker compose -f deployment/docker-compose.release.yml ps

# View live logs
docker compose -f deployment/docker-compose.release.yml logs -f

# Restart Collabase
docker compose -f deployment/docker-compose.release.yml restart

# Stop Collabase (data is kept)
docker compose -f deployment/docker-compose.release.yml down

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:
docker compose -f deployment/docker-compose.release.yml logs -f

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:
sudo ss -tlnp | grep ':80\|:443'

The AI / Brain feature is not available

The AI feature requires at least 4 GB of RAM. If your server has enough RAM and Brain is still not working, contact Collabase support.

I need help

Open a support ticket or submit a question at collabase.featurebase.app.