mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-11-24 05:13:10 +00:00
721061b046
* docs: unify nginx explainers and add apache httpd there are two places where nginx + certbot is explained, unify that into one place. Add apache httpd, following the same steps, but using mod_md for LetsEncrypt add a note about #453 in both guides. Link to both, and call the section reverse proxy, instead of NGINX * restore full nginx.conf from docker.md * add installation_guide/apache-httpd.md to mkdocs
143 lines
5.7 KiB
Markdown
143 lines
5.7 KiB
Markdown
# Binary Installation From Release
|
|
|
|
This is the binary installation guide for GoToSocial. It is assumed that you already have a [properly configured VPS running in the cloud, or a suitable homeserver that is accessible with port forwarding](index.md).
|
|
|
|
## 1: Prepare VPS
|
|
|
|
In a terminal on the VPS or your homeserver, make the directory that GoToSocial will run from, the directory it will use as storage, and the directory it will store LetsEncrypt certificates in:
|
|
|
|
```bash
|
|
mkdir /gotosocial && mkdir /gotosocial/storage && mkdir /gotosocial/storage/certs
|
|
```
|
|
|
|
If you don't have root permissions on the machine, use something like `~/gotosocial` instead.
|
|
|
|
## 2: Download Release
|
|
|
|
In a terminal on the VPS or your homeserver, cd into the base directory for GoToSocial you just created above:
|
|
|
|
```bash
|
|
cd /gotosocial
|
|
```
|
|
|
|
Now, download the latest GoToSocial release archive corresponding to the operating system and architecture you're running on.
|
|
|
|
For example, for version 0.1.0 running on 64-bit Linux:
|
|
|
|
```bash
|
|
wget https://github.com/superseriousbusiness/gotosocial/releases/download/v0.1.0/gotosocial_0.1.0_linux_amd64.tar.gz
|
|
```
|
|
|
|
Then extract it:
|
|
|
|
```bash
|
|
tar -xzf gotosocial_0.1.0_linux_amd64.tar.gz
|
|
```
|
|
|
|
This will put the `gotosocial` binary in your current directory, in addition to the `web` folder, which contains assets for the web frontend, and an `example` folder, which contains a sample configuration file.
|
|
|
|
## 3. Edit Configuration File
|
|
|
|
Copy the configuration file from the example folder into your current directory:
|
|
|
|
```bash
|
|
cp ./example/config.yaml .
|
|
```
|
|
|
|
Now open the file in your text editor of choice so that you can set some important configuration values. Change the following settings:
|
|
|
|
- Set `host` to whatever hostname you're going to be running the server on (eg., `example.org`).
|
|
- Set `port` to `443`.
|
|
- 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.
|
|
|
|
## 4: Run the Binary
|
|
|
|
You can now run the binary.
|
|
|
|
Start the GoToSocial server with the following command:
|
|
|
|
```bash
|
|
./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.
|
|
|
|
Note that for this example we're assuming that we're allowed to run on port 443 (standard https port), and that nothing else is running on this port.
|
|
|
|
## 5: Create and confirm your user
|
|
|
|
You can use the GoToSocial binary to also create, confirm, and promote your user account.
|
|
|
|
Run the following command to create a new account:
|
|
|
|
```bash
|
|
./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.
|
|
|
|
Run the following command to confirm the account you just created:
|
|
|
|
```bash
|
|
./gotosocial --config-path ./config.yaml admin account confirm --username some_username
|
|
```
|
|
|
|
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 --config-path ./config.yaml admin account promote --username some_username
|
|
```
|
|
|
|
Replace `some_username` with the username of the account you just created.
|
|
|
|
## 6. Login
|
|
|
|
You should now be able to log in to your instance using the email address and password of the account you just created. We recommend using [Pinafore](https://pinafore.social) or [Tusky](https://tusky.app) for this.
|
|
|
|
## 7. Enable the systemd service
|
|
|
|
If you don't like manually starting GoToSocial on every boot you might want to create a systemd service that does that for you.
|
|
First create a new user and group for your gotosocial installation.
|
|
|
|
```bash
|
|
sudo useradd -r gotosocial
|
|
sudo groupadd gotosocial
|
|
sudo usermod -a -G gotosocial gotosocial
|
|
```
|
|
|
|
Then make them the owner of your GoToSocial installation since they will need to read and write in it.
|
|
|
|
```bash
|
|
sudo chown -R gotosocial:gotosocial /gotosocial
|
|
```
|
|
|
|
You can find a `gotosocial.service` file in the `example` folder on [github](https://raw.githubusercontent.com/superseriousbusiness/gotosocial/main/example/gotosocial.service) or your installation.
|
|
Copy it to `/etc/systemd/system/gotosocial.service`.
|
|
|
|
```bash
|
|
sudo cp /gotosocial/example/gotosocial.service /etc/systemd/system/
|
|
```
|
|
|
|
Then use `sudoedit /etc/systemd/system/gotosocial.service` to change the `ExecStart=` and `WorkingDirectory=` lines according to your installation.
|
|
If you have been following this guide word for word the defaults should be fine.
|
|
After you're done enable the service.
|
|
|
|
```bash
|
|
sudo systemctl enable --now gotosocial.service
|
|
```
|
|
|
|
## 8. Install the Admin Control Panel (optional)
|
|
|
|
At some point you'll likely want to do things like change instance information, and block domains you don't want to interact with. See the [admin panel](../admin/admin_panel.md) instructions for this.
|
|
|
|
## 9. Reverse proxy (optional)
|
|
|
|
If you want to run other webservers on port 433 or want to add an additional layer of security you might want to use [nginx](./nginx.md) or [Apache httpd](./apache-httpd.md) as reverse proxy
|