Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation:System] Added documentation for configuring custom websocket port in NGINX #651

Merged
merged 1 commit into from
Feb 7, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions _docs/sysadmin/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,38 @@ You can use these [instructions](/sysadmin/installation/ansible).
cp submitty.cer submitty.pem
cat chain.cer >> submitty.pem
```
#### Configure Websocket Port

Submitty allows you to configure the websocket server to use a custom port. To do this:

Open the Submitty configuration file:

bash
/usr/local/submitty/config/submitty.json```

Add or modify the websocket_port field, for example:

"websocket_port": 9001
```
The websocket server will default to port 8443 if this value is not set.
Update the proxy_pass directive in your NGINX configuration
```(/etc/nginx/sites-available/submitty.conf)``` to match the new port:
```
location /ws {
proxy_pass http://127.0.0.1:9001; # Updated port here
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "Upgrade";
proxy_set_header Host $host;
}
```

Restart NGINX for the changes to take effect:

```
sudo systemctl restart nginx
```


7. We recommend that you should leave the PostgreSQL setup unless you know what
you're doing. If you are running PostgreSQL on the same server as Submitty,
Expand Down