diff --git a/README.md b/README.md index 5190ad5..ff0f0fc 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,29 @@ -http://localhost:3000 - -``` -This is an AT Protocol Personal Data Server (PDS): https://github.com/bluesky-social/atproto - -Most API routes are under /xrpc/ -``` +# bluesky-pds-docker +It is required to set the hostname of the container to your FQDN or use host networking on a server whose hostname is the FQDN. ## Deployment -### Generate Config: - ```bash -git clone ..... +git clone https://forgejo.gravityfargo.dev/gravityfargo/bluesky-pds-docker.git && cd bluesky-pds-docker + make create-config make generate-secrets -# edit the pds.env file to set the FQDN +# edit the config/pds.env file to set the FQDN + +docker pull forgejo.gravityfargo.dev/gravityfargo/bluesky-pds:0.4.74 +docker-compose up -d ``` -### Deploy with Docker - -```bash -PDS_HOSTNAME="pds.sheltersky.org" -docker run --rm --name bluesky-pds -p 3000:3000 -v ./pds.env:/pds/pds.env --hostname "${PDS_HOSTNAME}" --env-file ./pds.env bluesky-pds:0.4.74 -``` - -### Deploy with Docker Compose +### Example Docker Compose ```yaml services: bluesky-pds: - hostname: ${PDS_HOSTNAME} + container_name: bluesky-pds + hostname: sheltersky.social image: bluesky-pds:0.4.74 - env_file: ./pds.env ports: - 3000:3000 volumes: - - ./pds.env:/pds/pds.env -``` - -```bash -docker-compose up -d + - ./config:/pds ```