# Install Community Edition Legacy
If you experiment any issue, please describe your problem precisely in our ticket system on Github. (opens new window)
# 1. Retrieve Cytomine-bootstrap
Cytomine-bootstrap gathers all commands and scripts to manage your Cytomine instance.
To install last Cytomine Community version, run:
mkdir Cytomine_bootstrap/ cd Cytomine_bootstrap/ wget https://github.com/cytomine/Cytomine-bootstrap/archive/v3.1.0.zip -O bootstrap.zip unzip bootstrap.zip mv Cytomine-bootstrap-3.1.0/* . rm -rf bootstrap.zip Cytomine-bootstrap-3.1.0/
# 2. Configure Cytomine installation
Open the file
configuration.sh in a text editor.
# Configure URLs
In order to open Cytomine in your browser, URLs pointing to Cytomine components have to be configured.
CORE_URLis the URL of the main Cytomine server.
IMS_URLis the URL for the image server.
UPLOAD_URLis the URL used to upload new images.
UPLOAD_URL have to be different (even if they are pointing to the same host). As an example, cytomine.domain.my and cytomine.domain.my/ims will not work as ims is subURL of the main ones. cytomine.domain.my, cytomine-ims.domain.my, ... is a valid example.
Decide about the accessibility of your installation:
- To share your installation and make your Cytomine instance accessible from anywhere, create DNS entries and make their HTTP(S) ports (80/443) accessible for these URLs. This operation can often be realised by your network administrator or your IT department.
- To install locally (on a laptop for example), open the file
/etc/hostsin a text editor. Append these lines:where
127.0.0.1 $CORE_URL 127.0.0.1 $IMS_URL 127.0.0.1 $UPLOAD_URL 127.0.0.1 rabbitmq1
$UPLOAD_URLhave been substituted by the values you chose.
On Mac OS, run
sudo killall -HUP mDNSResponder after
# Configure disk paths
All paths referenced in
..._PATH configuration keys must exist and be mappable in the Docker engine.
# Other configuration
You can learn about the other variables on this dedicated page.
# 3. Start Cytomine
Initialize your Cytomine instance with the configuration you chose at previous step. Run
Then, start your Cytomine instance using
sudo bash start_deploy.sh
The first time, a lot of components have to be downloaded. Depending on network and server speed, this step can take several minutes.
# 4. First connection
You can now discover Cytomine by browsing the URL you chose for
CORE_URL. By default, a admin account has been created for you. The connect to the platform in your browser, retrieve the randomly generated admin password with
cat configs/core/cytomineconfig.groovy | grep adminPassword
Once connected, update the admin password.
# Update configuration
If you want to change the configuration of a running instance, update the
configuration.sh file and run
bash init.sh sudo bash restart.sh
# Stop Cytomine
To stop your Cytomine instance, use the
clean_docker_keep_data.sh script stored in Cytomine-bootstrap.
sudo bash clean_docker_keep_data.sh
The server is stopped but data (databases and images) are preserved.
← Architecture Upgrade →