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 README.md format. #68

Merged
merged 1 commit into from
Jan 30, 2023
Merged

Fix README.md format. #68

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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ You can setup your own config in [config](./config) folder and [docker-compose.y

## Start free5gc

Because we need to create tunnel interface, we need to use privileged container with root permission.

### Pull docker images from docker hub

```bash
Expand All @@ -20,9 +22,6 @@ docker compose pull

### [Optional] Build docker images in local

```bash
Because we need to create tunnel interface, we need to use privileged container with root permission.

```bash
# Clone the project
git clone https://github.com/free5gc/free5gc-compose.git
Expand All @@ -37,7 +36,7 @@ docker compose -f docker-compose-build.yaml build
### Run free5GC

You can create free5GC containers based on local images or docker hub images:
```bash

```bash
# use local images
docker compose -f docker-compose-build.yaml up
Expand All @@ -46,6 +45,7 @@ docker compose up # add -d to run in background mode
```

Destroy the established container resource after testing:

```bash
# Remove established containers (local images)
docker compose -f docker-compose-build.yaml rm
Expand Down