diff --git a/README.md b/README.md index 6203c04..c8ab7f6 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Open5GS 5G Core Network Functions images ready for Docker. This repository contains the Dockerfiles and docker compose files used to deploy a configurable 5G Core. +The repository uses the same release version tags as Open5GS, so to use an specific Open5GS version just select the appropiate tag. + +The Docker images are available in DockerHub: `borieher/:` + ## Use it All the images depend on the base image. So first, update the `.env` file with the desired values to use: @@ -45,7 +49,7 @@ docker compose -f compose-files/basic-v3/docker-compose.yaml --env-file=.env up docker-compose -f compose-files/basic-v2/docker-compose.yaml up -d ``` -## Use it +## Manage it ```bash # Run the basic deployment with docker compose (v2) docker compose -f compose-files/basic-v3/docker-compose.yaml --env-file=.env up -d diff --git a/docs/configuration.md b/docs/configuration.md index fce9346..8ba10ee 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -32,6 +32,7 @@ You can override the command being run in the container by using the command sec nssf: ... command: "-c /open5gs/config/nssf.yaml" + ... ``` ## The `basic` Docker compose deployment