# Install Community Edition
TIP
If you experiment any issues, please describe your problem precisely in our ticket system on Github. (opens new window)
WARNING
This version opens a new way to manage data within Cytomine. It is recommended for new projects starting from scratch, but not to upgrade projects already using any Cytomine Community Edition Legacy (version 2 or 3).
# Prerequisites
A cluster must be installed and running before proceeding with the installation. See Clusters.
# Installation
This installation procedure is intended for desktop or laptop computers running Debian-based Linux operating systems.
It is expected to have
root
permissions (sudo privileges in Debian/Ubuntu).
Clone the repository on your computer:
git clone --branch CE2025.1 https://github.com/cytomine/Cytomine-community-edition.git
1Go into the cloned folder:
cd Cytomine-community-edition
1Edit the file
cytomine.template
if you want to change default values (like URLs and/or SMTP setup)WARNING
The variable
SCHEDULER_MASTER_URL
andSCHEDULER_OAUTH_TOKEN
have to be set to the value generated by your cluster in order to use the App Engine. See MicroK8s Cytomine configuration for more information on how to get these values.Launch the Cytomine installer. This will create all the folders and files necessary to launch Cytomine with Compose:
sudo docker pull cytomine/installer sudo docker run -v $(pwd):/install --user "$(id -u):$(id -g)" --rm -it cytomine/installer:latest deploy -s /install
1
2Launch cytomine:
sudo docker compose up -d
1Cytomine is ready to be used:
- If you have kept the default values your Cytomine is now available on http://localhost/ (opens new window).
- By default, an admin account has been created for you. To connect to the platform in your browser, retrieve the randomly generated admin password by opening the
cytomine.yml
file and go toservices: default: core : constant: ADMIN_PASSWORD:
. You can use this password with theadmin
username to get authenticated on your Cytomine.
TIP
Once authenticated, it is recommended to update the default administrator password to a more secure password.
# Update configuration
To modify the configuration of a running instance:
Update the configuration in the
cytomine.template
file.Relaunch the Cytomine installer to apply the updates to your configuration file:
sudo docker pull cytomine/installer sudo docker run -v $(pwd):/install --user "$(id -u):$(id -g)" --rm -it cytomine/installer:latest deploy -s /install
1
2Restart your running instance:
sudo docker compose restart
1
# Stop Cytomine
To stop your Cytomine instance:
sudo docker compose down
The server will be stopped, but the data, including databases and images, will be preserved.
← Architecture Upgrade →