vicwalker.dev.br
Mirror from bluesky-social/pds
some README improvements
+26
-8
+26
-8
README.md
+26
-8
README.md
···
32
32
**Server Requirements**
33
33
* Public IPv4 address
34
34
* Public DNS name
35
-
* Public internet access permitted on port 80/tcp and 443/tcp
35
+
* Public inbound internet access permitted on port 80/tcp and 443/tcp
36
36
37
37
**Server Recommendations**
38
+
38
39
| | |
39
40
| ---------------- | ---------------- |
40
41
| Operating System | Ubuntu 22.04 LTS |
41
42
| Memory (RAM) | 2+ GB |
42
43
| CPU Cores | 2+ |
43
44
| Storage | 40+ GB SSD |
45
+
| Architectures | amd64, arm64 |
44
46
45
-
46
47
### Install your server
47
48
48
49
Install your Ubuntu 22.04 server, and then ensure that you can ssh to it.
49
50
50
-
**NOTE:** It is a good security practice to restrict inbound ssh access (port 22/tcp) to your own computer's public IP address. You can check your current public IP address using [ifconfig.me](https://ifconfig.me/).
51
+
**Note:** It is a good security practice to restrict inbound ssh access (port 22/tcp) to your own computer's public IP address. You can check your current public IP address using [ifconfig.me](https://ifconfig.me/).
51
52
52
53
### Open your firewall
53
54
···
57
58
58
59
#### Open ports on your cloud provider's firewall
59
60
60
-
In your cloud provider's console, the following ports should be open to access from the public internet.
61
+
In your cloud provider's console, the following ports should be open to inbound access from the public internet.
61
62
62
63
* 80/tcp (Used only for TLS certification verification)
63
64
* 443/tcp (Used for all application requests)
64
65
65
-
No need to set up TLS or redirect requests from port 80 to 443, we've included Caddy in the distribution and it should handle that for you.
66
+
**Note:** there is no need to set up TLS or redirect requests from port 80 to 443 because the Caddy web server, included in the Docker compose file, will handle this for you.
66
67
67
68
#### Open ports on your Linux firewall
68
69
···
73
74
$ sudo ufw allow 443/tcp
74
75
```
75
76
77
+
### Configure DNS for your domain
78
+
79
+
From your DNS provider's control panel, set up a domain with records pointing to your server.
80
+
81
+
| Name | Type | Value | TTL |
82
+
| ----------------- | ---- | ------------- | ---- |
83
+
| `example.com` | `A` | `12.34.56.78` | 600 |
84
+
| `*.example.com` | `A` | `12.34.56.78` | 600 |
85
+
86
+
**Note:**
87
+
* Replace `example.com` with your domain name.
88
+
* Replace `12.34.56.78` with your server's IP address.
89
+
* Some providers may use the `@` symbol to represent the root of your domain.
90
+
* The wildcard record is required when allowing users to create new accounts on your PDS.
91
+
76
92
### Install Docker
77
93
78
-
To install Docker CE (Community Edition) on Ubuntu 22.04, use the the following instructions. For other operating systems you may reference the [official Docker install guides](https://docs.docker.com/engine/install/).
94
+
On your server, install Docker CE (Community Edition), using the the following instructions. For other operating systems you may reference the [official Docker install guides](https://docs.docker.com/engine/install/).
79
95
80
-
**NOTE:** All of the following commands should be run on your server via ssh.
96
+
**Note:** All of the following commands should be run on your server via ssh.
81
97
82
98
#### Uninstall old versions
83
99
···
133
149
```
134
150
135
151
### Create the Caddyfile
152
+
153
+
Be sure to replace `example.com` with your own domain.
136
154
137
155
```bash
138
156
cat <<CADDYFILE | sudo tee /data/caddy/etc/caddy/Caddyfile
···
215
233
216
234
```bash
217
235
curl https://example.com/xrpc/_health
218
-
{"version":"v1.2.3"}
236
+
{"version":"0.2.2-beta.2"}
219
237
```
220
238
221
239
### Connecting to your server