diff options
author | 2022-02-08 12:17:18 +0100 | |
---|---|---|
committer | 2022-02-08 12:17:18 +0100 | |
commit | 4c294a596a9e0524f89b80e1608c3411f4fcf679 (patch) | |
tree | 23851533a5f1adb5442fd7c3c034578c34cd3f0d /docs/installation_guide | |
parent | update outdated comment (diff) | |
parent | [chore] Drone config update (#383) (diff) | |
download | gotosocial-4c294a596a9e0524f89b80e1608c3411f4fcf679.tar.xz |
Merge branch 'main' into media_refactor
Diffstat (limited to 'docs/installation_guide')
-rw-r--r-- | docs/installation_guide/binary.md | 9 | ||||
-rw-r--r-- | docs/installation_guide/nginx.md | 5 |
2 files changed, 9 insertions, 5 deletions
diff --git a/docs/installation_guide/binary.md b/docs/installation_guide/binary.md index 64a7e60ee..173237da0 100644 --- a/docs/installation_guide/binary.md +++ b/docs/installation_guide/binary.md @@ -51,6 +51,7 @@ Now open the file in your text editor of choice so that you can set some importa - Set `db-type` to `sqlite`. - Set `db-address` to `sqlite.db`. - Set `storage-local-base-path` to the storage directory you created above (eg., `/gotosocial/storage`). +- Set `letsencrypt-enabled` to `true`. - Set `letsencrypt-cert-dir` to the certificate storage directory you created above (eg., `/gotosocial/storage/certs`). The above options assume you're using SQLite as your database. If you want to use Postgres instead, see [here](../configuration/database.md) for the config options. @@ -62,7 +63,7 @@ You can now run the binary. Start the GoToSocial server with the following command: ```bash -./gotosocial server start --config-path ./config.yaml +./gotosocial --config-path ./config.yaml server start ``` The server should now start up and you should be able to access the splash page by navigating to your domain in the browser. Note that it might take up to a minute or so for your LetsEncrypt certificates to be created for the first time, so refresh a few times if necessary. @@ -76,7 +77,7 @@ You can use the GoToSocial binary to also create, confirm, and promote your user Run the following command to create a new account: ```bash -./gotosocial admin account create --config-path ./config.yaml --username some_username --email some_email@whatever.org --password SOME_PASSWORD +./gotosocial --config-path ./config.yaml admin account create --username some_username --email some_email@whatever.org --password SOME_PASSWORD ``` In the above command, replace `some_username` with your desired username, `some_email@whatever.org` with the email address you want to associate with your account, and `SOME_PASSWORD` with a secure password. @@ -84,7 +85,7 @@ In the above command, replace `some_username` with your desired username, `some_ Run the following command to confirm the account you just created: ```bash -./gotosocial admin account confirm --config-path ./config.yaml --username some_username +./gotosocial --config-path ./config.yaml admin account confirm --username some_username ``` Replace `some_username` with the username of the account you just created. @@ -92,7 +93,7 @@ Replace `some_username` with the username of the account you just created. If you want your user to have admin rights, you can promote them using a similar command: ```bash -./gotosocial admin account promote --config-path ./config.yaml --username some_username +./gotosocial --config-path ./config.yaml admin account promote --username some_username ``` Replace `some_username` with the username of the account you just created. diff --git a/docs/installation_guide/nginx.md b/docs/installation_guide/nginx.md index 9cf454cad..7d39971a3 100644 --- a/docs/installation_guide/nginx.md +++ b/docs/installation_guide/nginx.md @@ -59,6 +59,7 @@ The file you're about to create should look a bit like this: ```nginx.conf server { listen 80; + listen [::]:80; server_name example.com; location / { proxy_pass http://localhost:8080; @@ -67,6 +68,8 @@ server { } ``` +Note: You can remove the line `listen [::]:80;` if your server is not ipv6 capable or you'd rather not use ipv6. + Change `proxy_pass` to the ip and port that you're actually serving GoToSocial on and change `server_name` to your own domain name. If your domain name is `gotosocial.example.com` then `server_name gotosocial.example.com;` would be the correct value. If you're running GoToSocial on another machine with the local ip of 192.168.178.69 and on port 8080 then `proxy_pass http://192.168.178.69:8080;` would be the correct value. @@ -86,7 +89,7 @@ sudo nginx -t If everything is fine you should get this as output: -``` +```text nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful ``` |