Activity Pub Reverse Proxy Framework
Find a file
2023-10-26 22:19:08 -03:00
scripts lint pass 2023-10-26 22:19:08 -03:00
tests validate schema on module tests 2022-12-07 15:26:11 -03:00
.gitignore Initial commit 2022-12-03 19:06:50 +00:00
conf.lua add config file loading 2022-12-06 18:24:25 -03:00
config.lua lint pass 2023-10-26 22:19:08 -03:00
ctx.lua lint pass 2023-10-26 22:19:08 -03:00
docker-compose.yaml add config file loading 2022-12-06 18:24:25 -03:00
LICENSE Initial commit 2022-12-03 19:06:50 +00:00
main.lua lint pass 2023-10-26 22:19:08 -03:00
Makefile add Makefile 2022-12-06 18:25:26 -03:00
nginx.conf add hook for init_by_lua_block 2022-12-07 15:40:48 -03:00
README.md README: update wording 2022-12-07 02:03:23 -03:00
test.lua lint pass 2023-10-26 22:19:08 -03:00
util.lua lint pass 2023-10-26 22:19:08 -03:00

aproxy

Activity Pub Reverse Proxy Framework

this is a collection of OpenResty scripts that provide different functionality on top of ActivityPub implementations.

Installation

the fuck is openresty

Get OpenResty: http://openresty.org/en/

For those not in the know, OpenResty is a "soft fork" of the god NGINX. It adds various modules but the most important of them is Lua scripting (provided by another god, LuaJIT)

It is an effective replacement to your NGINX installation, but you can have them coexisting (say, NGINX on port 80, OpenResty being reverse proxied by NGINX on port 8069, though I wouldn't recommend it in production environments).

actually installing aproxy

mkdir /opt
git clone https://gitdab.com/luna/aproxy

cd aproxy
mkdir /etc/aproxy
cp ./conf.lua /etc/aproxy/conf.lua
$EDITOR /etc/aproxy/conf.lua

now to configuring openresty to use aproxy

Say, you already have your reverse proxy block to your instance as such:

http {
    server {
        server_name example.com;
        location / {
            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
            proxy_set_header Host $http_host;
            proxy_pass http://localhost:4000;
        }
    }
}

You need to do the following:

  • Configure OpenResty package path so that it can call aproxy.
  • Insert aproxy as a callback on location / { block

It'll look something like this:

http {
    lua_package_path '/opt/?.lua;/opt/aproxy/?.lua;;';
        
    server {
        server_name example.com;
        location / {
            # set this to 'on' after you have tested that it actually works.
            # once you do that, performance will be increased
            # while the friction to quickly debug aproxy will also be increased
            lua_code_cache off;
            access_by_lua_block {
                require("aproxy.main")()
            }

            proxy_http_version 1.1;
            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";
            proxy_set_header Host $http_host;
            proxy_pass http://localhost:4000;
        }
    }
}

Running the test suite

requires luarocks, luajit, and nothing else.

make testdeps
eval (luarocks-5.1 path --bin)
make test