Skip to content

ASGI and nginx documentation need a few updates #3252

@dhdaines

Description

@dhdaines

The ASGI document should mention that in order to run umap via ASGI, you must install the umap-project[sync] optional dependencies - specifically, redis is required for it to load.

Also perhaps this optional dependency configuration should be called [async]?

Also the suggested configuration for nginx is not quite functional. It should have this change:

- proxy_pass http://umap/;
+ proxy_pass http://unix:/srv/umap/umap.sock:/;

And a link to https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_pass for more information

It may be useful to note that the map configuration section needs to be at the top level outside a server section. This could link to https://nginx.org/en/docs/http/websocket.html for more information

Also, the systemd unit file should have this fairly obvious change:

-     --uds /srv/umap/uvicorn.sock \
+     --uds /srv/umap/umap.sock \

And it may be useful to note that the file mentioned in EnvironmentFile should be used to set the UMAP_SETTINGS environment variable (and can also be used to set other ones).

I can supply a PR of course!

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions