Merge pull request #163 from oliveiraleo/expand-reload-script-appendix

Expand reload script appendix
free5gc · Oct 22, 2024 · 32ad890 · 32ad890
2 parents 7e38662 + 858edfd
commit 32ad890
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 9 deletions.
diff --git a/docs/guide/3-install-free5gc.md b/docs/guide/3-install-free5gc.md
@@ -116,13 +116,12 @@ sudo systemctl disable ufw # prevents the firewall to wake up after a OS reboot
 
 Or use `reload_host_config.sh` from free5GC
 ```
-sudo ./<PATH-TO-free5GC>/reload_host_config.sh <interface>
-
-Example:
+sudo ./<PATH-TO-free5GC>/reload_host_config.sh <dn_interface>
+# Example
 sudo ./free5gc/reload_host_config.sh enp0s3
 ```
 
-**Note:** In Ubuntu Server 20.04 and 22.04 the dn_interface may be called `enp0s3` or `enp0s4` by default. Use the command `ip a` to help to figure it out
+**Note:** For more information regarding the reload script, please, check [this appendix section](./Appendix.md#appendix-h-using-the-reload_host_configsh-script)
 
 ## B. Install Control Plane Elements
 

diff --git a/docs/guide/Appendix.md b/docs/guide/Appendix.md
@@ -155,20 +155,37 @@ Reference: [MongoDB official website](https://www.mongodb.com/docs/manual/tutori
 
 The script was designed to help reapplying [the configurations](./5-install-ueransim.md#7-testing-ueransim-against-free5gc) after a VM reboot
 
+### Usage
+
 Its usage is fairly simple, just run
 
 ```bash
-./reload_host_config.sh <dn_interface>
+cd ~/free5gc # go back to free5gc's main folder
+sudo reload_host_config.sh <dn_interface>
 ```
 
-For example, if your DN interface (e.g. free5GC's VM LAN interface) is named `enp0s4`, the command above will be
+For example, if your DN interface (e.g. free5GC's VM LAN interface) is called `enp0s4`, the command above will be
 
 ```bash
-./reload_host_config.sh enp0s4
+sudo reload_host_config.sh enp0s4
 ```
 
-If you are unsure regarding the name of the interface, run `ip a` (see the image below) to help to figure it out
+**Note:** In Ubuntu Server 20.04 and 22.04 the dn_interface may be called `enp0s3` or `enp0s4` by default
+
+If you are unsure about the interface name, run `ip a` to help to figure it out (see the image below)
 
 ![](./images/A-reload-config-script-example.png)
 
 An example of the expected output is depicted above
+
+### Reset iptables rules
+
+There is a parameter to completely reset the firewall rules (by default, the script only appends free5gc's required rules)
+
+Just add `-reset-firewall` to the script input
+
+```bash
+sudo reload_host_config.sh enp0s4 -reset-firewall
+```
+
+So it will clear all rules, then apply the required rules
diff --git a/docs/guide/Trouble_Shooting.md b/docs/guide/Trouble_Shooting.md
@@ -116,7 +116,7 @@ To see the details of H2C packets, do the following configuration.
 
     Decode the packets from the TCP ports listened by each NF as HTTP2 packets.
 
-### 10. To clear all iptables rules
+### 10. Clear all iptables rules
 
 If something went wrong, it's possible to reset iptables' rules back using:
 ```bash
@@ -131,6 +131,8 @@ sudo iptables -X
 
 Then remember to add back the [rules required](./5-install-ueransim.md#7-testing-ueransim-against-free5gc) by the free5GC.
 
+**Note:** You may consider using the `reload_host_config.sh` script for this task (see [this appendix section](./Appendix.md#appendix-h-using-the-reload_host_configsh-script))
+
 ### 11. Fix UERANSIM's EAP-AKA' behavior
 
 If you face issues similar to the one reported on [the forum](https://forum.free5gc.org/t/authentication-method-eap-aka-not-working/2260) or the message `SEMANTICALLY_INCORRECT_MESSAGE` when seting up UERANSIM's UE after configuring it to use EAP-AKA-PRIME as authentication method on Webconsole, check the solution below: