From 2eb00b27cfc8600d724c54e4b97e5edc36bd0220 Mon Sep 17 00:00:00 2001
From: Eduardo Schulz <eduardo.schulz@protonmail.com>
Date: Thu, 21 Mar 2024 19:19:23 -0300
Subject: [PATCH] add core docs

---
 docs/core-network/cores.md   | 12 ++++++-
 docs/core-network/free5gc.md | 66 +++++++++++++++++++++++++++++++++++-
 docs/core-network/oaicn.md   |  9 +++--
 docs/core-network/open5gs.md | 49 +++++++++++++++++++++++++-
 4 files changed, 131 insertions(+), 5 deletions(-)

diff --git a/docs/core-network/cores.md b/docs/core-network/cores.md
index 4e768b5..c046b3b 100644
--- a/docs/core-network/cores.md
+++ b/docs/core-network/cores.md
@@ -1 +1,11 @@
-# 
\ No newline at end of file
+# Core Networks
+
+## OpenAirInterface CN
+[Setup](./oaicn.md)
+
+## Free5GC 
+[Setup](./free5gc.md)
+
+## Open5GS
+[Setup](./open5gs.md)
+
diff --git a/docs/core-network/free5gc.md b/docs/core-network/free5gc.md
index 4e768b5..6e05b20 100644
--- a/docs/core-network/free5gc.md
+++ b/docs/core-network/free5gc.md
@@ -1 +1,65 @@
-# 
\ No newline at end of file
+# Free5GC Core Network
+
+## 1. Set Up
+In our test we used the version v3.3.0.
+
+### 1.1 Core-host Configurations
+
+```shell
+sudo sysctl net.ipv4.conf.all.forwarding=1
+sudo iptables -P FORWARD ACCEPT
+```
+
+### 1.2 Clone free5gc-compose
+
+```shell
+git clone https://github.com/free5gc/free5gc-compose
+git checkout v3.3.0
+```
+
+### 1.3 Changing Core Settings
+
+```shell
+git clone https://github.com/eduardoschulz/Interoperabilidade.git
+cd Interoperabilidade/core-networks/free5gc/core-networks/FREE5GC
+cp -r config path/to/free5gc-compose 
+```
+
+### 1.4 gNB-host Configurations
+You also must configure a route to the internal docker network so that the gNB can make a connection.
+
+```shell
+sudo ip route add 10.100.200.0/24 via {ip_addr_corehost} dev {interface}
+
+#example
+sudo ip route add 10.100.200.0/24 via 191.4.205.38 dev br01
+```
+
+## 2.0 Installing GTP-U Kernel Module
+
+```shell
+git clone https://github.com/free5gc/gtp5g.git && cd gtp5g
+make clean && make
+sudo make install
+``` 
+
+## 3.0 Deploying the Core Network
+
++ To start the core
+```shell
+cd path-to/free5gc-compose
+docker compose up -d
+```
++ To stop the core
+```shell
+docker compose down 
+```
+
+### 3.1 Adding UE to Core Database
+To set up your UEs you'll need to go to the free5gc webpage on your machine. You should see a login screen when accessing http://<core-ip>:3000. The credentials are **admin** and the password is **free5gc**.
+
+## 4.0 More Information
+
+[Free5GC - Github Page](https://github.com/free5gc/free5gc)
+[Free5GC - Compose](https://github.com/free5gc/free5gc-compose)
+[Free5GC - Forum](https://forum.free5gc.org/)
diff --git a/docs/core-network/oaicn.md b/docs/core-network/oaicn.md
index ffd7573..d8e3137 100644
--- a/docs/core-network/oaicn.md
+++ b/docs/core-network/oaicn.md
@@ -20,8 +20,6 @@ git checkout v1.5.0
 git clone https://github.com/eduardoschulz/Interoperabilidade.git
 cd Interoperabilidade/core-networks/OAI-CN/
 
-rm -r ~/oai-cn5g-fed/docker-compose/database
-cp -r database ~/oai-cn5g-fed/docker-compose/database
 
 mv docker-compose-basic-nrf.yaml ~/oai-cn5g-fed/docker-compose/
 ```
@@ -67,6 +65,13 @@ INSERT INTO `SessionManagementSubscriptionData` (`ueid`, `servingPlmnid`, `singl
 ```
 **The configuration above is only going to last until the core is restarted**. If you want to make this static you must make changes on the db files inside path/oaicn/docker-compose/databases/.
 
+If you want to use ours:
+
+```shell
+rm -r ~/oai-cn5g-fed/docker-compose/database
+cp -r database ~/oai-cn5g-fed/docker-compose/database
+```
+
 ## 3.0 More Information
 
 [Basic Deployment using Docker Compose](https://gitlab.eurecom.fr/oai/cn5g/oai-cn5g-fed/-/blob/master/docs/DEPLOY_SA5G_BASIC_DEPLOYMENT.md)
diff --git a/docs/core-network/open5gs.md b/docs/core-network/open5gs.md
index 4e768b5..2de0a6d 100644
--- a/docs/core-network/open5gs.md
+++ b/docs/core-network/open5gs.md
@@ -1 +1,48 @@
-# 
\ No newline at end of file
+# Open5gs Core Network
+
+## 1. Set Up
+In our test we used the version v2.7.0
+
+### 1.1 Core-host Configurations
+
+```shell
+sudo sysctl net.ipv4.conf.all.forwarding=1
+sudo iptables -P FORWARD ACCEPT
+```
+
+### 1.2 Clone free5gc-compose
+
+```shell
+git clone https://github.com/herlesupreeth/docker_open5gs
+git checkout v2.7.0
+```
+
+### 1.3 Changing Core Settings
+
+```shell
+git clone https://github.com/eduardoschulz/Interoperabilidade.git
+cd Interoperabilidade/core-networks/OPEN5GS
+cp sa-deploy.yaml /path/to/docker_open5gs/.
+cp .env /path/to/docker_open5gs/. 
+
+cp -r smf/ /path/to/docker_open5gs/ #here you need to modify your dnn 
+cp -r upf/ /path/to/docker_open5gs/ #same thing as above
+```
+
+## 2.0 Deploying the Core Network
+
++ To start the core
+```shell
+cd path-to/docker_open5gs
+docker compose -f sa-deploy.yaml up -d
+```
++ To stop the core
+```shell
+docker compose down 
+```
+
+### 3.1 Adding UE to Core Database
+To set up your UEs you'll need to go to the open5gs webpage on your machine. You should see a login screen when accessing http://<core-ip>:3000. The credentials are **admin** and the password is **1423**.
+
+## 4.0 More Information
+