Skip to content

Add info about reverse proxying #90

@EvilSquirrelGuy

Description

@EvilSquirrelGuy

Describe the Suggestion

I this this project would benefit from providing some sort of notice about using reverse proxies, as NGINX's default configuration does not work. The buffer sizes aren't adequate for the volume of data being transferred, and the cache policy is more of an obstacle than a help, with API calls failing in most cases if it fails.

Running on Forge 1.18.2, Mod version: 1.4, Create version: 0.5.1.i

This could be in the form of a few bullet points stating that you need to disable caching of /api, and potentially providing a sample nginx config that demonstrates these changes?

Sample config

server {

  server_name railways.<example.org>;

  client_body_buffer_size 32K;   # Increase buffer size (adjust as necessary)
  client_max_body_size 25M;      # Set max body size (adjust as necessary)

  location / {
    proxy_pass http://<server.ip>:3876;
    proxy_buffering off;
    proxy_request_buffering off;
    proxy_connect_timeout 120s;
    proxy_read_timeout 120s;
    proxy_send_timeout 120s;
    include proxy_params;
  }

  listen [::]:80 ssl;
  listen 80 ssl;

}

I just wanted to create this issue in case anyone else struggles with this again.

Screenshots and Videos

No response

Additional Context

This is just a documentation suggestion, I didn't notice a wiki, so I wanted to just document this in the issues tab. Feel free to close it if it's not really relevant.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions