openitcockpit/openitcockpit-ce repository overview

⁠openITCOCKPIT-CE-docker

This repository contains the necessary files to run openITCOCKPIT Community Edition as a container.

It requires Docker Compose or a compatible alternative.

Please see the official documentation for more information: https://docs.openitcockpit.io/en/installation/docker⁠

⁠Prerequisites

Before running openITCOCKPIT Community Edition with Docker, make sure you have the following prerequisites installed on your system:

• Docker: Install Docker⁠
• Docker Compose: Install Docker Compose⁠

⁠Supported architectures:

• amd64
• arm64v8

⁠Getting Started

To get started with openITCOCKPIT Community Edition using Docker, follow these steps:

1. Clone this repository to your local machine:

   git clone https://github.com/openITCOCKPIT/openITCOCKPIT-ce-docker.git
   

   Copy

2. Navigate to the cloned repository:

   cd openITCOCKPIT-ce-docker
   

   Copy

3. Run the Docker Compose command to start openITCOCKPIT:

   docker compose up -d
   

   Copy

4. Wait for the containers to start and initialize the application.

5. Once the containers are up and running, you can access openITCOCKPIT Community Edition by opening a web browser and entering the following URL:

   https://localhost
   

   Copy

6. Follow the on-screen instructions to complete the initial setup of openITCOCKPIT.

⁠Configuration

The configuration for openITCOCKPIT Community Edition can be modified by editing the compose.yml file in the repository. You can adjust settings such as database credentials, ports, and volumes according to your requirements.

Most settings can be adjusted through environment variables. Please see the file openitcockpit.env, which contains all available environment variables with default values.

By default, openITCOCKPIT Community Edition will expose these ports:

• 80 (HTTP)
• 443 (HTTPS)

The default credentials are:

• E-Mail [email protected]
• Password: asdf12

You can change the default credentials before the first start of the docker container through the file openitcockpit.env:

[email protected]
OITC_ADMIN_PASSWORD=asdf12
OITC_ADMIN_FIRSTNAME=John
OITC_ADMIN_LASTNAME=Doe

If you have not changed the default credentials, you can still change the password or create a new user⁠ afterwords.

⁠Updating openITCOCKPIT

To update openITCOCKPIT Community Edition to the latest version, follow these steps:

1. Pull the latest changes from the repository:

   git pull origin main
   

   Copy

2. Stop and remove the running containers:

   docker compose down
   

   Copy

3. Run the Docker Compose command again to start the updated version:

   docker compose up --pull always -d
   

   Copy

⁠Troubleshooting

If you encounter any issues or have questions regarding openITCOCKPIT Community Edition with Docker, please refer to the official documentation⁠.

⁠Contributing

Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a pull request in this repository.

Bugs or issues related to openITCOCKPIT itself should be created in the corresponding repository: https://github.com/openITCOCKPIT/openITCOCKPIT⁠

⁠License

Copyright (C) 2015-2025  it-novum GmbH
Copyright (C) 2025-today Allgeier IT Services GmbH

openITCOCKPIT is dual licensed

1)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 3 of the License.


This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.


You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

2)
If you purchased an openITCOCKPIT Enterprise Edition you can use this file
under the terms of the openITCOCKPIT Enterprise Edition licence agreement.
Licence agreement and licence key will be shipped with the order
confirmation.

⁠Support

For any further assistance or support, please reach out to the openITCOCKPIT Community⁠.