Mirrors/gotosocial
2
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial synced 2024-11-15 01:07:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

[docs] Update apache-httpd.md (#937)

Browse source
This commit is contained in:
EchedeyLR 2022-11-01 09:36:10 +00:00 committed by GitHub
parent 47de702506
commit ba46e622f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/installation_guide/apache-httpd.md
View file

@ -29,7 +29,7 @@ sudo zypper install apache2
You'll also need to install additional modules for Apache HTTP Server. You can do that with the following command: You'll also need to install additional modules for Apache HTTP Server. You can do that with the following command:
```bash ```bash
sudo a2enmod proxy_http md ssl headers proxy_wstunnel sudo a2enmod proxy_http md ssl headers rewrite
``` ```
## Configure GoToSocial ## Configure GoToSocial
@ -70,16 +70,24 @@ The file you're about to create should look a bit like this:
```apache ```apache
MDomain example.com auto MDomain example.com auto
MDCertificateAgreement accepted MDCertificateAgreement accepted
<VirtualHost *:80 > <VirtualHost *:80 >
ServerName example.com ServerName example.com
</VirtualHost> </VirtualHost>
<VirtualHost *:443> <VirtualHost *:443>
ServerName example.com ServerName example.com
RewriteEngine On
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteCond %{HTTP:Connection} upgrade [NC]
RewriteRule ^/?(.*) "ws://localhost:8080/$1" [P,L]
SSLEngine On SSLEngine On
ProxyPreserveHost On ProxyPreserveHost On
ProxyPassMatch ^/(api/v1/streaming.*)$ ws://localhost:8080/$1
ProxyPass / http://localhost:8080/ ProxyPass / http://localhost:8080/
ProxyPassReverse / http://localhost:8080/ ProxyPassReverse / http://localhost:8080/
RequestHeader set "X-Forwarded-Proto" expr=https RequestHeader set "X-Forwarded-Proto" expr=https
</VirtualHost> </VirtualHost>
``` ```
@ -88,6 +96,8 @@ Again, replace occurrences of `example.com` in the above config file with the ho
You should also change `http://localhost:8080` to the correct address and port of your GtS server. For example, if you're running GoToSocial on another machine with the local ip of `192.168.178.69` and on port `8080` then `http://192.168.178.69:8080/` would be the correct value. You should also change `http://localhost:8080` to the correct address and port of your GtS server. For example, if you're running GoToSocial on another machine with the local ip of `192.168.178.69` and on port `8080` then `http://192.168.178.69:8080/` would be the correct value.
`Rewrite*` directives are needed to ensure that Websocket streaming connections also work. See the [websocket](./websocket.md) document for more information on this.
`ProxyPreserveHost On` is essential: It guarantees that the proxy and the GoToSocial speak of the same Server name. If not, GoToSocial will build the wrong authentication headers, and all attempts at federation will be rejected with 401 Unauthorized. `ProxyPreserveHost On` is essential: It guarantees that the proxy and the GoToSocial speak of the same Server name. If not, GoToSocial will build the wrong authentication headers, and all attempts at federation will be rejected with 401 Unauthorized.
The line `ProxyPassMatch ^/(api/v1/streaming.*)$ ws://localhost:8080/$1` ensures that Websocket streaming connections also work. See the [websocket](./websocket.md) document for more information on this. The line `ProxyPassMatch ^/(api/v1/streaming.*)$ ws://localhost:8080/$1` ensures that Websocket streaming connections also work. See the [websocket](./websocket.md) document for more information on this.
@ -150,15 +160,19 @@ The file you're about to create should look initially for both 80 (required) and
```apache ```apache
<VirtualHost *:80> <VirtualHost *:80>
ServerName example.com ServerName example.com
RewriteEngine On
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteCond %{HTTP:Connection} upgrade [NC]
RewriteRule ^/?(.*) "ws://localhost:8080/$1" [P,L]
ProxyPreserveHost On ProxyPreserveHost On
ProxyPassMatch ^/(api/v1/streaming.*)$ ws://localhost:8080/$1
ProxyPass / http://localhost:8080/ ProxyPass / http://localhost:8080/
ProxyPassReverse / http://localhost:8080/ ProxyPassReverse / http://localhost:8080/
</VirtualHost> </VirtualHost>
``` ```
In the case of providing an initial setup for the 443 port looking for additional managing by an external tool, you could use default certificates provided by the server which you can find referenced in the `default-ssl.conf` file at `/etc/apache2/sites-available/`.
Again, replace occurrences of `example.com` in the above config file with the hostname of your GtS server. If your domain name is `gotosocial.example.com`, then `gotosocial.example.com` would be the correct value. Again, replace occurrences of `example.com` in the above config file with the hostname of your GtS server. If your domain name is `gotosocial.example.com`, then `gotosocial.example.com` would be the correct value.
You should also change `http://localhost:8080` to the correct address and port of your GtS server. For example, if you're running GoToSocial on another machine with the local ip of `192.168.178.69` and on port `8080` then `http://192.168.178.69:8080/` would be the correct value. You should also change `http://localhost:8080` to the correct address and port of your GtS server. For example, if you're running GoToSocial on another machine with the local ip of `192.168.178.69` and on port `8080` then `http://192.168.178.69:8080/` would be the correct value.
@ -167,6 +181,8 @@ You should also change `http://localhost:8080` to the correct address and port o
The line `ProxyPassMatch ^/(api/v1/streaming.*)$ ws://localhost:8080/$1` ensures that Websocket streaming connections also work. See the [websocket](./websocket.md) document for more information on this. The line `ProxyPassMatch ^/(api/v1/streaming.*)$ ws://localhost:8080/$1` ensures that Websocket streaming connections also work. See the [websocket](./websocket.md) document for more information on this.
In the case of providing an initial setup for the 443 port looking for additional managing by an external tool, you could use default certificates provided by the server which you can find referenced in the `default-ssl.conf` file at `/etc/apache2/sites-available/`.
Save and close the config file. Save and close the config file.
Now we'll need to link the file we just created to the folder that Apache HTTP Server reads configurations for active sites from. Now we'll need to link the file we just created to the folder that Apache HTTP Server reads configurations for active sites from.