chore: readme, license and cleanup

Author: cr0ssing

.github/workflows/build-and-push-ghcr.yaml

@@ -1,3 +1,19 @@
+# Copyright (C) 2024 Robin Lamberti.
+
+# This file is part of pdsadmin-docker.
+
+# pdsadmin-docker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# pdsadmin-docker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with pdsadmin-docker. If not, see <http://www.gnu.org/licenses/>.
 name: build-and-push-ghcr
 on:
   push:

Dockerfile

@@ -1,3 +1,20 @@
+# Copyright (C) 2024 Robin Lamberti.
+
+# This file is part of pdsadmin-docker.
+
+# pdsadmin-docker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# pdsadmin-docker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with pdsadmin-docker. If not, see <http://www.gnu.org/licenses/>.
+
 FROM debian:stable-slim
 
 LABEL org.opencontainers.image.source=https://github.com/cr0ssing/pdsadmin-docker

README.MD

@@ -0,0 +1,14 @@
+# PDS Admin for Docker
+![Github Actions Status](https://github.com/cr0ssing/pdsadmin-docker/actions/workflows/build-and-push-ghcr.yaml/badge.svg) ![GitHub License](https://img.shields.io/github/license/cr0ssing/pdsadmin-docker) ![GitHub Release](https://img.shields.io/github/v/release/cr0ssing/pdsadmin-docker)
+
+
+This repository provides a way to use the [Bluesky Personal Data Server](https://github.com/bluesky-social/pds) admin CLI fully dockerized. This makes it possible to use named volumes to store the application data used by pds and pdsadmin and isntall both by using a single docker compose file. This also makes it easier to sync the environment variables between both components.
+
+## Usage
+1. configure your `.env` file. You can copy the `example.env` file and fill in the \<placeholders>. Generate secret 1 and 2 with `openssl rand --hex 16` and secret 3 with `openssl ecparam --name secp256k1 --genkey --noout --outform DER | tail --bytes=+8 | head --bytes=32 | xxd --plain --cols 32` (from the PDS repo's install script)
+2. (optional) if you're using a reverse proxy e.g. traefik adjust the labels of the `pds` service in the docker compose file.
+3. use `docker compose up` to start the PDS and the PDS Admin CLI
+4. you can now access the cli with `./pdsadmin.sh`. If you want you can put this script on your PATH to access it more seamlessly.
+
+## License
+This project is licensed under GPL 3.0.

add_license_header.sh

@@ -0,0 +1,26 @@
+#!/bin/bash
+
+# Copyright (C) 2024 Robin Lamberti.
+
+# This file is part of pdsadmin-docker.
+
+# pdsadmin-docker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# pdsadmin-docker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with pdsadmin-docker. If not, see <http://www.gnu.org/licenses/>.
+
+for i in $(find ./ -name '*.yaml') # or whatever other pattern...
+do
+  if ! grep -q Copyright $i
+  then
+    cat copyright_header.txt $i >$i.new && mv $i.new $i
+  fi
+done

copyright_header.txt

@@ -0,0 +1,16 @@
+# Copyright (C) 2024 Robin Lamberti.
+
+# This file is part of pdsadmin-docker.
+
+# pdsadmin-docker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# pdsadmin-docker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with pdsadmin-docker. If not, see <http://www.gnu.org/licenses/>.

docker-compose.yaml

@@ -1,3 +1,20 @@
+# Copyright (C) 2024 Robin Lamberti.
+
+# This file is part of pdsadmin-docker.
+
+# pdsadmin-docker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# pdsadmin-docker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with pdsadmin-docker. If not, see <http://www.gnu.org/licenses/>.
+
 version: '3.9'
 
 services:

example.env

@@ -1,5 +1,5 @@
 PDS_HOSTNAME=<your-domain.com>
-PDS_JWT_SECRET=<secret>
+PDS_JWT_SECRET=<secret 1>
 PDS_ADMIN_PASSWORD=<secret 2>
 PDS_PLC_ROTATION_KEY_K256_PRIVATE_KEY_HEX=<secret 3>
 
@@ -13,4 +13,7 @@ PDS_REPORT_SERVICE_DID=did:plc:ar7c4by46qjdydhdevvrndac
 PDS_CRAWLERS=https://bsky.network
 LOG_ENABLED=true
 NODE_ENV=production
-PDS_PORT=3000
+PDS_PORT=3000
+PDS_EMAIL_SMTP_URL=<email_user>:Y<email_password><smpt_server>
+PDS_EMAIL_FROM_ADDRESS=<email>
+PDS_SERVICE_HANDLE_DOMAINS=<.your-domain.com>,<.also.your-domain.com>

pdsadmin.sh

@@ -1,3 +1,20 @@
 #! /bin/sh
 
+# Copyright (C) 2024 Robin Lamberti.
+
+# This file is part of pdsadmin-docker.
+
+# pdsadmin-docker is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# pdsadmin-docker is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with pdsadmin-docker. If not, see <http://www.gnu.org/licenses/>.
+
 docker exec -it pdsadmin ./pdsadmin.sh $@