Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(installation): switch to new compose docker plugin #27

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix(installation): switch to new compose docker plugin #27

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
290c5c4
fix(installation): switch to new compose docker plugin
Aug 10, 2024
080b8ff
fix: scope docker commands to compose stack
Aug 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions docs/installation/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ The Docker installation is the method to choose if you want to quickly deploy Op

## Requirements ##

The current documentation has been tested on **Debian 10** and **Ubuntu LTS 20.04** with the following requirements :
The current documentation has been tested on **Debian 10**, **Rocky Linux 9** and **Ubuntu LTS 20.04** with the following requirements :

<ul>
<li>Docker-compose 1.21.0+</li>
<li>Docker 20.10.1+</li>
<li>Docker Compose v2.27.0</li>
<li>Docker 26.1.1</li>
<li>5 GB RAM</li>
</ul>

Expand All @@ -34,7 +34,7 @@ Update the following keys in the `opencve.cfg` file:
- smtp_user & smtp_password if any or leave empty

!!!tip
If you want to change the default postgresql password (strongly advised), you can add it in the `.env` file before the docker-compose build:
If you want to change the default postgresql password (strongly advised), you can add it in the `.env` file before the docker compose build:

```
POSTGRES_PASSWORD=MyStrongPassword42
Expand All @@ -51,29 +51,29 @@ Update the following keys in the `opencve.cfg` file:
You can now build the OpenCVE image:

```
$ docker-compose build
$ docker compose build
```

Then start everything except the beat:

```
$ docker-compose up -d postgres redis webserver celery_worker
$ docker compose up -d postgres redis webserver celery_worker
```

## Initialize the database ##

The database can be initialized with the following command:

```
$ docker exec -it webserver opencve upgrade-db
$ docker compose exec -it webserver opencve upgrade-db
```

## Import the data ##

The tables are created, you can now populate them using the `import-data` command :

```
$ docker exec -it webserver opencve import-data
$ docker compose exec -it webserver opencve import-data
```

This command download the list of CPE, the list of CWE and each CVE's year (from 2002 until now), so **it can take several minutes**. Don't worry you will only do it once.
Expand All @@ -90,7 +90,7 @@ This command download the list of CPE, the list of CWE and each CVE's year (from
You can now create the admin :

```
$ docker exec -it webserver opencve create-user john [email protected] --admin
$ docker compose exec -it webserver opencve create-user john [email protected] --admin
Password:
Repeat for confirmation:
[*] User john created.
Expand All @@ -104,7 +104,7 @@ Repeat for confirmation:
The last step is to start the scheduler :

```
$ docker-compose up -d celery_beat
$ docker compose up -d celery_beat
```

You can now use OpenCVE with your own dockerized instance of it.