Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Omidznlp committed Jul 22, 2021
1 parent 2ecd0b0 commit d71be9a
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 5 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ The other protocoles will be supportted in the future.
#### Prerequisites

Frrouting must be installed from following link:\
http://docs.frrouting.org/projects/dev-guide/en/latest/building-frr-for-ubuntu2004.html
http://docs.frrouting.org/projects/dev-guide/en/latest/building-frr-for-ubuntu2004.html . \
And then
```
$ git clone https://github.com/Omidznlp/REST-API-FRRouting.git
$ cd REST-API-FRRouting
Expand Down
2 changes: 1 addition & 1 deletion bgp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Configuration
BGP daemon must be enabled before testing. To do , `bgpd=no` must be changed to `bgpd=yes` into `/etc/frr/daemons` and then restart frr \
`Note:`\
Implemented parameters are referred to in https://docs.frrouting.org/en/latest/bgp.html.
Implemented parameters are referred to https://docs.frrouting.org/en/latest/bgp.html.
Please note that some parameters should not be configured together. To address, if they are configured, one of them would be ignored when commands are inserted into Frr
## Test
BGP parameters are divided into three section:\
Expand Down
2 changes: 1 addition & 1 deletion ospf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ospfd_instances=1,2,3
...
```
`Note:`\
Implemented parameters are referred to in https://docs.frrouting.org/en/latest/ospfd.html. \
Implemented parameters are referred to https://docs.frrouting.org/en/latest/ospfd.html. \
For supporting multi-instance, please check the following link:
https://frrouting.readthedocs.io/en/latest/ospfd.html#multi-instance-support

Expand Down
4 changes: 4 additions & 0 deletions policyroutes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@
## Configuration
PBR daemon must be enabled before testing. To do that, `pbrd=yes` must be inserted into `/etc/frr/daemons` and then restart frr \
`Note:`\
`Note:`\
Implemented parameters are referred to https://docs.frrouting.org/en/latest/pbr.html ,\
https://docs.frrouting.org/en/latest/filter.html , \
https://docs.frrouting.org/en/latest/routemap.html
Please note that some parameters should not be configured together. To address, if they are configured, one of them would be ignored when commands are inserted into Frr
##Test
Policy routes are divided to four section:\
Expand Down
2 changes: 1 addition & 1 deletion rip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Configuration
RIP daemon must be enabled before testing. To do that, `ripd=yes` must be inserted into `/etc/frr/daemons` and then restart frr \
`Note:`\
Implemented parameters are referred to in https://docs.frrouting.org/en/latest/ripd.html.
Implemented parameters are referred to https://docs.frrouting.org/en/latest/ripd.html.
### Test Requests

**Description:**\
Expand Down
2 changes: 1 addition & 1 deletion static/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Configuration
Static daemon must be enabled before testing. To do that, `staticd=yes` must be inserted into `/etc/frr/daemons` and then restart frr.
`Note:`\
Implemented parameters are referred to in https://docs.frrouting.org/en/latest/static.html.
Implemented parameters are referred to https://docs.frrouting.org/en/latest/static.html.
### Test Requests
Exp1: insert
```
Expand Down

0 comments on commit d71be9a

Please sign in to comment.