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

update docker readme with compose V2 info #190

Merged
merged 1 commit into from
Nov 29, 2023
Merged

update docker readme with compose V2 info #190

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 15 additions & 2 deletions docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,17 @@ entrypoint, and the [gunicorn](https://gunicorn.org/) configuration file.
## Prerequisites

- [Docker](https://docs.docker.com/engine/install/)
- [docker-compose](https://docs.docker.com/compose/install/) >= 1.27.0
- [docker-compose](https://docs.docker.com/compose/install/) >= 1.27.0 (In July 2023, Compose V1 has been deprecated)

or

- [Compose V2](https://docs.docker.com/compose/migrate/), which is part of standard Docker Engine installation
- (Optional) [Vim](https://www.vim.org/) or other text editor - for configuration and development

Please note it is important to use the abovementioned version of
`docker-compose` or newer, otherwise the build and deploy will fail.

## Quickly build and run Taranis NG using `docker-compose`
## Quickly build and run Taranis NG using `docker-compose` or `docker compose`

_First_, you need to clone the source code repository:

Expand All @@ -66,12 +70,21 @@ _Finally_, either deploy the ready-made images from Docker hub with:
docker-compose -f docker/docker-compose.yml pull
docker-compose -f docker/docker-compose.yml up --no-build
```
or
```bash
docker compose -f docker/docker-compose.yml pull
docker compose -f docker/docker-compose.yml up --no-build
```

or, alternatively, build and run the containers with:

```bash
TARANIS_NG_TAG=build docker-compose -f docker/docker-compose.yml up --build --pull
```
or
```bash
TARANIS_NG_TAG=build docker compose -f docker/docker-compose.yml up --build --pull
```
(`--pull` updates the base images)

**Voila, Taranis NG is up and running. Visit your instance by navigating to
Expand Down