{"id":17793076,"url":"https://github.com/lucasrodcosta/nginx-studies","last_synced_at":"2025-09-16T15:32:29.165Z","repository":{"id":76830200,"uuid":"590138641","full_name":"lucasrodcosta/nginx-studies","owner":"lucasrodcosta","description":"A collection of studies with Nginx","archived":false,"fork":false,"pushed_at":"2023-01-23T21:07:06.000Z","size":1301,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-12-28T10:26:19.037Z","etag":null,"topics":["nginx"],"latest_commit_sha":null,"homepage":"","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lucasrodcosta.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-17T18:34:09.000Z","updated_at":"2023-02-21T07:51:52.000Z","dependencies_parsed_at":"2023-03-01T06:45:26.570Z","dependency_job_id":null,"html_url":"https://github.com/lucasrodcosta/nginx-studies","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasrodcosta%2Fnginx-studies","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasrodcosta%2Fnginx-studies/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasrodcosta%2Fnginx-studies/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lucasrodcosta%2Fnginx-studies/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lucasrodcosta","download_url":"https://codeload.github.com/lucasrodcosta/nginx-studies/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233275518,"owners_count":18651573,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nginx"],"created_at":"2024-10-27T11:03:59.750Z","updated_at":"2025-09-16T15:32:23.810Z","avatar_url":"https://github.com/lucasrodcosta.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nginx studies\n\nA set of studies about how Nginx works and how it interacts with the operating system under the hoods.\n\nEach directory is a study, with a README file containing the instructions to reproduce it, some logs and\nnotes.\n\n- [sendfile](https://github.com/lucasrodcosta/nginx-studies/tree/main/sendfile)\n- [tcp_nopush](https://github.com/lucasrodcosta/nginx-studies/tree/main/tcp_nopush)\n- TODO: kTLS\n- TODO: http/2\n- TODO: http/3\n\n## Requirements\n\nAll studies requires an OpenResty docker image with debug flag and [strace](https://strace.io/).\n\n1. Clone the [docker-openresty repo](https://hub.docker.com/r/openresty/openresty)\n\n2. Add the flag `--with-debug` inside the `RESTY_CONFIG_OPTIONS` in file `alpine/Dockerfile`:\n\n    ```Dockerfile\n    ARG RESTY_CONFIG_OPTIONS=\"\\\n    --with-debug \\\n    --with-compat \\\n    // other lines\n    ```\n\n3. Add the instruction `RUN apk add strace` before the copy of Nginx conf files in `alpine/Dockerfile`:\n\n    ```Dockerfile\n    # Add additional binaries into PATH for convenience\n    ENV PATH=$PATH:/usr/local/openresty/luajit/bin:/usr/local/openresty/nginx/sbin:/usr/local/openresty/bin\n\n    RUN apk add strace\n\n    # Copy nginx configuration files\n    COPY nginx.conf /usr/local/openresty/nginx/conf/nginx.conf\n    ```\n\n4. Build the Nginx:\n\n    ```bash\n    docker build -t openresty-with-debug:latest -f alpine/Dockerfile .\n    ```\n\n## How to run the images of the studies\n\n1. Run Nginx:\n\n    ```bash\n    make run\n    ```\n\n2. In another terminal, attach the strace process to Nginx:\n\n    ```bash\n    make strace\n    ```\n\n3. In another terminal, reload the Nginx:\n\n    ```bash\n    make reload\n    ```\n\n4. Make the requests. Each study has its own instructions about this step.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasrodcosta%2Fnginx-studies","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flucasrodcosta%2Fnginx-studies","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flucasrodcosta%2Fnginx-studies/lists"}