Modify nginx-1.16.1 to nginx-1.25.2 in docs.

Remove doc/F-Stack_Binary_Release_Quick_Start.md.
This commit is contained in:
fengbojiang 2023-10-19 16:02:50 +08:00
parent 5de047f19a
commit 993b574472
6 changed files with 5 additions and 100 deletions

View File

@ -123,7 +123,7 @@ Currently, besides authorized DNS server of DNSPod, there are various products i
#### Nginx
cd app/nginx-1.16.1
cd app/nginx-1.25.2
bash ./configure --prefix=/usr/local/nginx_fstack --with-ff_module
make
make install

View File

@ -1,95 +0,0 @@
# F-Stack Binary Release Quick Start
## How to use
Before you start to use f-stack-binary-release package, please make sure you:
- have access to the internet
- have at least one NIC up
- have root permission
- meet all other requirements of dpdk
```sh
$ sudo -i
$ wget https://github.com/F-Stack/f-stack/releases/download/v1.12/f-stack-binary-release.tar.gz
$ tar zxf f-stack-binary-release.tar.gz
$ cd f-stack-binary-release/scripts
# set_env.sh will offload the NIC, if you only have one NIC, the following three commands must run in a script
$ ./set_env.sh dev_name
$ ./run_app.sh [app_name]
$ ./config_veth0.sh
```
- dev_name is the name of your NIC, you can see it with *ifconfig* or *ip addr* command
- app_name is the name of application you want to run, now we support 'nginx' and 'redis'. If you do not add any argument, it will run a helloworld example, you can use it to test whether the envrionment is setup correctly.
- All the scripts should run with root permission
## Directory structure
```
+-- f-stack-binary-release
| +-- doc
| | +-- F-Stack_Build_Guide.md
| | +-- F-Stack_Binary_Release_Quick_Start.md
| +-- f-stack-release
| | +-- CentOS
| | | +-- app (nignx-1.11.10 redis-3.2.8)
| | | +-- config.ini
| | | +-- doc
| | | +-- dpdk
| | | +-- example
| | | +-- start.sh (a script helps to run applications)
| | | +-- tools
| | +-- RHEL
| | +-- Ubuntu
| | +-- kmod (kernel modules)
| | | +-- CentOS
| | | | +-- supported_kernel_version
| | | | | +-- igb_uio.ko
| | | | | +-- rte_kni.ko
| | | +-- RHEL
| | | +-- Ubuntu
| +-- scripts
| | +-- config_veth0.sh (configure the virtual NIC)
| | +-- run_app.sh (run a specific application)
| | +-- set_env.sh (setup environment that f-stack needs)
```
## Supported Linux releases
The f-stack-binary-release package has supported several frequent used linux releases, you can use f-stack applications directly on these releases. What should be paid attention to is that f-stack uses linux kernel modules, so if you have different kernel versions in your machine, you could not use this f-stack-quick-start package and need to compile f-stack by yourself. Here is the list of linux releases this package support now:
| Linux Release | Kernel |
| -------------- | ------ |
| CentOS 7.0 | 3.10.0-123.el7.x86_64 |
| CentOS 7.2 | 3.10.0-327.el7.x86_64 |
| CentOS 7.3 | 3.10.0-514.el7.x86_64 |
| CentOS 7.4 | 3.10.0-693.el7.x86_64 |
| CentOS 7.5 | 3.10.0-862.el7.x86_64 |
| RHEL 7.2 | 3.10.0-327.el7.x86_64 |
| RHEL 7.3 | 3.10.0-514.el7.x86_64 |
| RHEL 7.4 | 3.10.0-693.el7.x86_64 |
| RHEL 7.5 | 3.10.0-862.el7.x86_64 |
| Ubuntu 14.04.5 | 4.4.0-31-generic |
| Ubuntu 16.04.4 | 4.13.0-36-generic |
| Ubuntu 18.04 | 4.15.0-20-generic |
Also, we support tencent cloud, if you are using cloud virtual machine in cloud.tencent.com, you can also use this f-stack-quick-start package.
| Linux Release | Kernel |
| -------------- | ------ |
| CentOS 7.2 | 3.10.0-514.26.2.el7.x86_64 |
| CentOS 7.3 | 3.10.0-514.21.1.el7.x86_64 |
| CentOS 7.4 | 3.10.0-693.el7.x86_64 |
| Ubuntu 14.04.1 | 3.13.0-128-generic |
| Ubuntu 16.04.1 | 4.4.0-91-generic |
## Uninstall f-stack-binary-release package
```
$ sudo rm -rf /usr/local/nginx_fstack
$ rm -rf /path/to/f-stack-binary-release
```
## Compile f-stack by yourself
If your OS version is not in the above list or you want to compile f-stack by yourself, you can refer to another document [Build_Guide](https://github.com/F-Stack/f-stack/blob/master/doc/F-Stack_Build_Guide.md).

View File

@ -39,7 +39,7 @@ $ cd /data/f-stack/lib
$ make
# Compile Nginx
$ cd ../app/nginx-1.16.1
$ cd ../app/nginx-1.25.2
$ ./configure --prefix=/usr/local/nginx_fstack --with-ff_module
$ make
$ make install

View File

@ -4,7 +4,7 @@ F-Stack is an open source network framework based on DPDK. F-Stack supports stan
## How does Nginx use F-Stack?
Nginx APP is in `app/nginx-1.16.1` directory.
Nginx APP is in `app/nginx-1.25.2` directory.
```

View File

@ -78,7 +78,7 @@ The mount point can be made permanent across reboots, by adding the following li
### Compile Nginx
cd ../
cd app/nginx-1.16.1
cd app/nginx-1.25.2
./configure --prefix=/usr/local/nginx_fstack --with-ff_module
make
make install

View File

@ -75,7 +75,7 @@
make
# Compile Nginx
cd ../app/nginx-1.16.1
cd ../app/nginx-1.25.2
./configure --prefix=/usr/local/nginx_fstack --with-ff_module
make
make install