Installing Citeck using Docker Compose 

System Requirements 

Installed Docker
Installed Docker Compose
16 GB RAM for proper Citeck launch

Installing and Running Citeck Community 

Important

The kit comes with pre-filled demo data.

To disable this setting before deploying the stand, go to the folder \services\environments in the demo_data.env file, set WITH_DEMO_DATA to false.

We anonymously collect statistics using the Umami service. The service does not collect or store personal data, avoiding the need for cookies.

Install Docker and Docker Compose on your OS

Clone the repository:

git clone https://github.com/citeck/citeck-community.git

go to the folder with the cloned repository:

cd /полный/путь/до/папки

Start Citeck:
```
docker-compose up -d
```
Wait for the system to start (time depends on system performance).
Open a browser and navigate to: http://localhost/
Log in to the system:
```
Username: admin
Password: admin
```
If you need to change the password, see the instructions

Note

During the first deployment without demo data, keycloak will ask to change the password.
Then the personal workspace page will become available:

In the top left corner, a button is available to select available workspaces and create a new one:

Workspaces

Corporate Portal

Modules and Accounts

Ready-to-Use Functional Modules

Admin Section

Administrator Section

Note

During the first launch within the first 5 minutes after successful installation and login, errors may occur, for example:

Citeck deployment and launch continues, you need to wait.

Updating to the latest release 

Run the following commands in the terminal:

Stop Citeck:
```
docker-compose down
```

Go to the citeck-community folder:

cd /полный/путь/до/папки/citeck-community

Get the current version of Citeck:
```
git pull
```
Download the latest image versions:
```
docker-compose pull
```
Start Citeck:
```
docker-compose up -d
```

Environment preparation and Citeck installation 

Ubuntu Server 24.04 LTS

Installing Docker:

sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Добавьте репозиторий в источники Apt:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update

Install the latest available version:

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Or install a specific version:

apt-cache madison docker-ce | awk '{ print $3 }'
VERSION_STRING={Your Specific version}
sudo apt-get install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING \
    containerd.io docker-buildx-plugin docker-compose-plugin

Configure Docker autostart:

sudo systemctl enable docker

Install Docker Compose:

curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" \
    -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose

Verify the installation:

docker-compose --version

This completes the installation of Docker Engine and Docker-Compose.

Clone the repository and start Citeck:

wget https://github.com/Citeck/citeck-community/archive/refs/heads/master.zip
unzip master.zip
cd citeck-community-master
docker-compose pull
docker-compose up -d

Note

Execute from the citeck-community-master directory

If the local network may overlap with the Docker network, specify a predefined subnet in the /etc/docker/daemon.json file (parameter default-address-pools):

{
    "default-address-pools": [
        {"base": "172.19.0.0/16", "size": 24}
    ]
}

Debian 11 “Bullseye”

Installing Docker:

sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Добавьте репозиторий в источники Apt:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update

Install the latest available version:

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Or install a specific version:

apt-cache madison docker-ce | awk '{ print $3 }'
VERSION_STRING={Your Specific version}
sudo apt-get install docker-ce=$VERSION_STRING docker-ce-cli=$VERSION_STRING \
    containerd.io docker-buildx-plugin docker-compose-plugin

Configure Docker autostart:

sudo systemctl enable docker

Install Docker Compose:

wget https://github.com/docker/compose/releases/download/v2.29.1/docker-compose-Linux-x86_64
mv ./docker-compose-Linux-x86_64 /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Note

The version can be changed to a more current one by replacing v2.29.1

This completes the installation of Docker Engine and Docker-Compose.

Clone the repository and start Citeck:

wget https://github.com/Citeck/citeck-community/archive/refs/heads/master.zip
unzip master.zip
cd citeck-community-master
docker-compose pull
docker-compose up -d

Note

Execute from the citeck-community-master directory

If the local network may overlap with the Docker network, specify a predefined subnet in the /etc/docker/daemon.json file (parameter default-address-pools):

{
    "default-address-pools": [
        {"base": "172.19.0.0/16", "size": 24}
    ]
}

Astra Linux Orel

Note

The instructions were tested with Astra Linux Common Edition 2.12.46.

Installing Docker:

sudo apt update
sudo apt install apt-transport-https ca-certificates curl gnupg2 software-properties-common
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -
sudo printf "deb [arch=amd64] https://download.docker.com/linux/debian stretch stable \n" \
    > /etc/apt/sources.list.d/docker.list
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io

Configuring docker groups:

sudo groupadd docker
sudo usermod -aG docker $USER
sudo systemctl enable docker.service
sudo systemctl enable containerd.service

Install Docker Compose:

wget https://github.com/docker/compose/releases/download/1.27.4/docker-compose-Linux-x86_64
mv ./docker-compose-Linux-x86_64 /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Note

The version can be changed to a more current one by replacing 1.27.4

Clone the repository and start Citeck (run in terminal, Alt+T):

git clone https://github.com/Citeck/citeck-community.git && cd citeck-community
docker-compose pull
docker-compose up -d

Note

Run commands from the citeck-community directory.

If the local network may overlap with the Docker network, specify a predefined subnet in the /etc/docker/daemon.json file (parameter default-address-pools):

{
    "default-address-pools": [
        {"base": "172.19.0.0/16", "size": 24}
    ]
}

Red OS

Note

The instructions were tested on RED OS 7.3| Linux Kernel 5.15.72

Update packages and disable SELINUX:

dnf update
echo 'SELINUX=disabled' > /etc/sysconfig/selinux
reboot

Installing Docker and Docker Compose:

sudo dnf install docker-ce docker-ce-cli docker-compose
systemctl enable docker

Clone the repository and start Citeck (run in terminal, Alt+T):

git clone https://github.com/Citeck/citeck-community.git && cd citeck-community
docker-compose pull
docker-compose up -d

Note

If you encounter the error unknown log opt ‘max-size’ for journald log driver, open /etc/docker/deamon.json and change “log-driver”: “journald” to “log-driver”: “json-file”

If the local network may overlap with the Docker network, specify a predefined subnet in the /etc/docker/daemon.json file (parameter default-address-pools):

{
    "default-address-pools": [
        {"base": "172.19.0.0/16", "size": 24}
    ]
}

Oracle Enterprise Linux 8.9

Installing Docker:

sudo dnf update -y
sudo dnf install -y dnf-utils ca-certificates curl
sudo dnf config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
sudo dnf makecache
sudo dnf install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Configure Docker autostart:

sudo systemctl start docker
sudo systemctl enable docker

To make the docker-compose command available directly (and not just docker compose):

sudo ln -s /usr/libexec/docker/cli-plugins/docker-compose /usr/bin/docker-compose

This completes the installation of Docker Engine and Docker-Compose.

Note

For Enterprise builds, log in to the registry: docker login <registry host>.

Registry URL and authentication data can be requested from the Citeck contact person.

Clone the repository and start Citeck:

wget https://github.com/Citeck/citeck-community/archive/refs/heads/master.zip
unzip master.zip
cd citeck-community-master
docker-compose pull
docker-compose up -d

Note

Execute from the citeck-community-master directory

If the local network may overlap with the Docker network, specify a predefined subnet in the /etc/docker/daemon.json file (parameter default-address-pools):

{
    "default-address-pools": [
        {"base": "172.19.0.0/16", "size": 24}
    ]
}

Switching to BASIC authentication instead of Keycloak 

If you need a simple configuration method for system access bypassing Keycloak, you can configure BASIC Auth (not recommended for production environments).

Open the ecos-proxy-app.env file:

nano citeck-community-master/services/environments/ecos-proxy-app.env

Replace the line:

ENABLE_OIDC_FULL_ACCESS=true

with:

ENABLE_OIDC_FULL_ACCESS=false

In the same file, add:
```
BASIC_AUTH_ACCESS=admin:admin,fet:fet
```
Note

admin:admin,fet:fet — the list of users with access to the system. Format: {{username_0}}:{{password_0}},{{username_1}}:{{password_1}}. After adding, the new user will be registered as a separate ecos-proxy-app entry; changes take effect after restart.
in the citeck-community-master directory to stop the project
```
docker-compose down
```
Start the project:
```
docker-compose up -d
```

Citeck login credentials:

Username: admin
Password: admin

Docker Services 

By the link services are listed from Docker’s perspective and their settings.

Note

Some containers start once and then remain in exited status, for example:

citeck-community-master-ecos-meetings-ecos-apps-1
citeck-community-master-ecos-order-pass-ecos-apps-1
citeck-community-master-ecos-common-data-list-ecos-apps-1
citeck-community-master-ecos-assignments-ecos-apps-1

Installing Citeck using Docker Compose 

System Requirements 

Installing and Running Citeck Community 

Updating to the latest release 

Environment preparation and Citeck installation 

Switching to BASIC authentication instead of Keycloak 

Docker Services 

Possible Issues 

Windows 

MacOS 

How to 