vicwalker.dev.br
Mirror from bluesky-social/pds
Add Debian 12 to the list of supported distributions
+29
-26
+25
-25
README.md
+25
-25
README.md
···
45
45
* Public inbound internet access permitted on port 80/tcp and 443/tcp
46
46
47
47
**Server Recommendations**
48
-
| | |
49
-
| ---------------- | ---------------- |
50
-
| Operating System | Ubuntu 22.04 |
51
-
| Memory (RAM) | 2+ GB |
52
-
| CPU Cores | 2+ |
53
-
| Storage | 40+ GB SSD |
54
-
| Architectures | amd64, arm64 |
48
+
| | |
49
+
| ---------------- | ------------ |
50
+
| Operating System | Ubuntu 22.04 |
51
+
| Memory (RAM) | 2+ GB |
52
+
| CPU Cores | 2+ |
53
+
| Storage | 40+ GB SSD |
54
+
| Architectures | amd64, arm64 |
55
55
56
56
**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/).
57
57
···
70
70
71
71
From your DNS provider's control panel, set up a domain with records pointing to your server.
72
72
73
-
| Name | Type | Value | TTL |
74
-
| ----------------- | ---- | ------------- | ---- |
75
-
| `example.com` | `A` | `12.34.56.78` | 600 |
76
-
| `*.example.com` | `A` | `12.34.56.78` | 600 |
73
+
| Name | Type | Value | TTL |
74
+
| --------------- | ---- | ------------- | --- |
75
+
| `example.com` | `A` | `12.34.56.78` | 600 |
76
+
| `*.example.com` | `A` | `12.34.56.78` | 600 |
77
77
78
78
**Note:**
79
79
* Replace `example.com` with your domain name.
···
93
93
94
94
These should all return your server's public IP.
95
95
96
-
## Automatic install on Ubuntu 22.04 or Debian 11
96
+
## Automatic install on Ubuntu 20.04/22.04 or Debian 11/12
97
97
98
98
On your server via ssh, run the installer script:
99
99
···
309
309
310
310
You will need to customize various settings configured through the PDS environment variables. See the below table to find the variables you'll need to set.
311
311
312
-
| Environment Variable | Value | Should update? | Notes |
313
-
| ----------------------------------------- | --------------------------------------------- | -------------- |------ |
314
-
| PDS_HOSTNAME | example.com | ✅ | Public domain you intend to deploy your service at |
315
-
| PDS_JWT_SECRET | jwt-secret | ✅ | Use a secure high-entropy string that is 32 characters in length |
316
-
| PDS_ADMIN_PASSWORD | admin-pass | ✅ | Use a secure high-entropy string that is 32 characters in length |
317
-
| PDS_REPO_SIGNING_KEY_K256_PRIVATE_KEY_HEX | 3ee68... | ✅ | See above Generate Keys section - once set, do not change |
318
-
| PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX | e049f... | ✅ | See above Generate Keys section - once set, do not change |
319
-
| PDS_DB_SQLITE_LOCATION | /pds/pds.sqlite | ❌ | Or use `PDS_DB_POSTGRES_URL` depending on which database you intend to use |
320
-
| PDS_BLOBSTORE_DISK_LOCATION | /pds/blocks | ❌ | Only update if you update the mounted volume for your docker image as well |
321
-
| PDS_DID_PLC_URL | https://plc.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
322
-
| PDS_BSKY_APP_VIEW_URL | https://api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
323
-
| PDS_BSKY_APP_VIEW_DID | did:web:api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
324
-
| PDS_CRAWLERS | https://bgs.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
312
+
| Environment Variable | Value | Should update? | Notes |
313
+
| ----------------------------------------- | ---------------------------- | -------------- | --------------------------------------------------------------------------- |
314
+
| PDS_HOSTNAME | example.com | ✅ | Public domain you intend to deploy your service at |
315
+
| PDS_JWT_SECRET | jwt-secret | ✅ | Use a secure high-entropy string that is 32 characters in length |
316
+
| PDS_ADMIN_PASSWORD | admin-pass | ✅ | Use a secure high-entropy string that is 32 characters in length |
317
+
| PDS_REPO_SIGNING_KEY_K256_PRIVATE_KEY_HEX | 3ee68... | ✅ | See above Generate Keys section - once set, do not change |
318
+
| PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX | e049f... | ✅ | See above Generate Keys section - once set, do not change |
319
+
| PDS_DB_SQLITE_LOCATION | /pds/pds.sqlite | ❌ | Or use `PDS_DB_POSTGRES_URL` depending on which database you intend to use |
320
+
| PDS_BLOBSTORE_DISK_LOCATION | /pds/blocks | ❌ | Only update if you update the mounted volume for your docker image as well |
321
+
| PDS_DID_PLC_URL | https://plc.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
322
+
| PDS_BSKY_APP_VIEW_URL | https://api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
323
+
| PDS_BSKY_APP_VIEW_DID | did:web:api.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
324
+
| PDS_CRAWLERS | https://bgs.bsky-sandbox.dev | ❌ | Do not adjust if you intend to federate with the Bluesky federation sandbox |
325
325
326
326
There are additional environment variables that can be tweaked depending on how you're running your service. For instance, storing blobs in AWS S3, keys in AWS KMS, or setting up an email service.
327
327
+4
-1
installer.sh
+4
-1
installer.sh
···
91
91
if [[ "${DISTRIB_CODENAME}" == "bullseye" ]]; then
92
92
SUPPORTED_OS="true"
93
93
echo "* Detected supported distribution Debian 11"
94
+
elif [[ "${DISTRIB_CODENAME}" == "bookworm" ]]; then
95
+
SUPPORTED_OS="true"
96
+
echo "* Detected supported distribution Debian 12"
94
97
fi
95
98
fi
96
99
97
100
if [[ "${SUPPORTED_OS}" != "true" ]]; then
98
-
echo "Sorry, only Ubuntu 20.04, 22.04, and Debian 11 are supported by this installer. Exiting..."
101
+
echo "Sorry, only Ubuntu 20.04, 22.04, Debian 11 and Debian 12 are supported by this installer. Exiting..."
99
102
exit 1
100
103
fi
101
104