README.en.md · hshq/nginx-unit-lua

# nginx-unit-lua

## English doc / [中文文档](README.md)

#### Description
From Baidu translation.

Lua5.4/luajit of Nginx-Unit support.
It can run the Lor/Vanilla frameworks and make targeted openresty adaptation.

Only the HTTP function is preliminarily realized.
Only tested on MacOS.

#### Software Architecture
Lua is not integrated into Unit like those languages officially supported by Unit,
It is in the form of an external application (the configuration type is `external`).

When the Unit starts (or when the application configuration changes), start the Lua application process according to the configuration.
Interact with the Unit communication module that has been compiled into the Lua shared library.
The Unit main process will start three functional process controllers, routers and application prototypes,
And several application processes, and various processes communicate with each other.

- `build/`      The source code and dependencies required to build the library.
- `lib/`        Library files that the runtime depends on.
- `config/`     Runtime and app configurations.
- `frameworks/` App dependent framework.
- `apps/`       App 。
- `unitd.lua`   UNIT service management, viewing status and configuration, and app startup entry.

#### Installation

1.  dependence：
    - [lua-cjson](https://github.com/openresty/lua-cjson)
    - [base64](https://github.com/aklomp/base64)
    - [luaffifb](https://github.com/facebookarchive/luaffifb)

2.  Compile `build/deps/base64` :
    1.  - Unzip [base64](https://github.com/aklomp/base64) Source package in `build/deps/`,
        - `MacOS`: modify `./Makefile`, comment out the `$(OBJCOPY)` instruction under the target `lib/libbase64.o`,
        - (In MacOS, it will cause compilation failure, operation failure and symbol not found.)
    2. ```
        # Generate files lib/libbase64.o, lib/config.h
        # x86
        SSSE3_CFLAGS=-mssse3 \
        SSE41_CFLAGS=-msse4.1 \
        SSE42_CFLAGS=-msse4.2 \
        AVX2_CFLAGS=-mavx2 \
        AVX_CFLAGS=-mavx \
            make lib/libbase64.o
        ```
    3. ```(cd test; make test) # Execute test and benchmark```

3.  Build `nginx-unit-lua` :
    ```
    cd ..
    # For lua5.4 generate ./Makefile and Makefile of each shared library
    # Compile configuration: ./make/inc.lua and make.lua in each shared library directory
    # luajit make.lua
    ./make.lua # -g generate debug information, -r release
    make
    make clean
    ```

#### Instructions

- In `UNIT-ROOT/`:
    - `config/config.lua` configures UNIT, registers frameworks and apps.
    - Execute `./unitd.lua` for management, you can specify the following commands:
        - `[i[nfo]]`
            Default command, view the list of available commands and registered apps
        - `r[estart], s[tart], q[uit]`
            Manage unitd
        - `v[host] [APP-NAME/No.]`
            View the current vhost configuration of UNIT in JSON format
        - `d[etail] [APP-NAME/No.]`
            If there is no parameter, all the registered apps' information will be listed.
            If the app parameter is specified, its registration information, configuration information, NGX configuration and vhost configuration will be displayed.
        - `u[pdate] [APP-NAME/No.]`
            Process and update the vhosts configuration of the UNIT.
        - `g[et] <APP-NAME/No.>`
            Get request test

#### Contribution

1.  Fork the repository
2.  Create Feat_xxx branch
3.  Commit your code
4.  Create Pull Request

hshq/nginx-unit-lua

简介

发行版

贡献者

语言

近期动态

hshq/nginx-unit-lua .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

语言

近期动态

搜索帮助

hshq/nginx-unit-lua