Mirror from bluesky-social/pds
replace pdsadmin account commands with goat (#313)
* replace pdsadmin account commands with goat
* clarify within-docker goat syntax
authored by
Alex Garnett
and committed by
GitHub
e23b1a99
c96ed43b
+19
-14
+1
-1
Dockerfile
+1
-1
Dockerfile
···
8
8
ENV GODEBUG="netdns=go"
9
9
WORKDIR /tmp
10
10
RUN apk add --no-cache git go
11
-
RUN git clone https://github.com/bluesky-social/goat.git && cd goat && git checkout v0.2.1 && go build -o /tmp/goat-build .
11
+
RUN git clone https://github.com/bluesky-social/goat.git && cd goat && git checkout v0.2.2 && go build -o /tmp/goat-build .
12
12
13
13
# Move files into the image and install
14
14
WORKDIR /app
+16
-11
README.md
+16
-11
README.md
···
24
24
- [Check that DNS is working as expected](#check-that-dns-is-working-as-expected)
25
25
- [Installing on Ubuntu 20.04/22.04/24.04 and Debian 11/12/13](#installing-on-ubuntu-200422042404-and-debian-111213)
26
26
- [Verifying that your PDS is online and accessible](#verifying-that-your-pds-is-online-and-accessible)
27
-
- [Creating an account using pdsadmin](#creating-an-account-using-pdsadmin)
27
+
- [goat CLI](#goat-cli)
28
+
- [Creating an account](#creating-an-account)
28
29
- [Creating an account using an invite code](#creating-an-account-using-an-invite-code)
29
30
- [Using the Bluesky app with your PDS](#using-the-bluesky-app-with-your-pds)
30
31
- [Setting up SMTP](#setting-up-smtp)
31
32
- [Common SMTP issues](#common-smtp-issues)
32
33
- [Logging](#logging)
33
34
- [Updating your PDS](#updating-your-pds)
34
-
- [goat CLI](#goat-cli)
35
35
- [Environment Variables](#environment-variables)
36
36
- [Migrating your PDS](#migrating-your-pds)
37
37
- [License](#license)
···
222
222
223
223
Note that there will be no events output on the WebSocket until they are created in the PDS, so the above command may continue to run with no output immediately post-installation.
224
224
225
-
### Creating an account using pdsadmin
225
+
### goat CLI
226
+
227
+
The PDS image includes [goat](https://github.com/bluesky-social/goat), our command line tool for performing admin functions. `goat` can be used locally with a `--pds-host` parameter or within the container installed by this script.
226
228
227
-
You'll now have access to some additional command line tools on this server. Use `pdsadmin` to create an account if you haven't already:
229
+
### Creating an account
230
+
231
+
You can run the `goat` command included in this container with `docker exec pds goat`.
232
+
233
+
Use `goat pds admin account create` to create an account if you haven't already:
228
234
229
235
```bash
230
-
sudo pdsadmin account create
236
+
docker exec pds goat pds admin account create --admin-password `PDS_ADMIN_PASSWORD` --handle newuser.pds.net --email new-user@email.com --password new-password
231
237
```
238
+
239
+
> [!NOTE]
240
+
> You can find `PDS_ADMIN_PASSWORD` in `/pds/pds.env` following installation. You can typically skip this arg when running `goat` from the `docker` container as `PDS_ADMIN_PASSWORD` should already be set.
232
241
233
242
### Creating an account using an invite code
234
243
235
-
If needed, use `pdsadmin` to create an invite code:
244
+
If needed, use `goat` to create an invite code:
236
245
237
246
```bash
238
-
sudo pdsadmin create-invite-code
247
+
docker exec pds goat pds admin --admin-password PDS_ADMIN_PASSWORD create-invites
239
248
```
240
249
241
250
When creating an account using the app, enter this invite code.
···
316
325
```bash
317
326
sudo pdsadmin update
318
327
```
319
-
320
-
### goat CLI
321
-
322
-
The PDS image includes [goat](https://github.com/bluesky-social/goat), our command line tool for performing admin functions. `goat` is more portable than the `pdsadmin` scripts and can be used locally or within the container installed by this script.
323
328
324
329
### Environment Variables
325
330
+2
-2
installer.sh
+2
-2
installer.sh
···
413
413
Check service status : sudo systemctl status pds
414
414
Watch service logs : sudo docker logs -f pds
415
415
Backup service data : ${PDS_DATADIR}
416
-
PDS Admin command : pdsadmin
416
+
PDS Admin command : docker exec pds goat pds admin
417
417
418
418
Required Firewall Ports
419
419
------------------------------------------------------------------------
···
431
431
432
432
Detected public IP of this server: ${PUBLIC_IP}
433
433
434
-
To see pdsadmin commands, run "pdsadmin help"
434
+
To see pds admin commands, run "docker exec pds goat pds admin"
435
435
436
436
========================================================================
437
437
INSTALLER_MESSAGE