···3535Open source and community-maintained. For questions, open an issue
36363737**Disclaimer:** This is a community list. Always review server terms and privacy policies before joining.
3838-{
3939- "url": "https://ypds.example.com",
4040- "supportedHandles": ["*.example.com", "*.example.net"],
4141- "maintainer": "@your-handle.example.com",
4242- "tosUrl": "https://pds.example.com/terms",
4343- "privacyUrl": "https://pds.example.com/privacy",
4444- "inviteCodeRequired": false
4545-}
4646-```
4747-4848-### Field Descriptions
4949-5050-| Field | Type | Required | Description |
5151-|-------|------|----------|-------------|
5252-| `url` | string | ✅ Yes | The base URL of your PDS server (must include https://) |
5353-| `supportedHandles` | array of strings | ✅ Yes | Domain patterns for handles your PDS supports (e.g., `*.example.com`) |
5454-| `maintainer` | string | ✅ Yes | Bluesky handle of the server maintainer (format: `@handle.domain.com`) |
5555-| `contactEmail` | string | ⚠️ Optional | Contact email for the PDS administrator |
5656-| `tosUrl` | string | ⚠️ Optional | URL to your Terms of Service page |
5757-| `privacyUrl` | string | ⚠️ Optional | URL to your Privacy Policy page |
5858-| `inviteCodeRequired` | boolean | ✅ Yes | Whether new users need an invite code to join (`true` or `false`) |
5959-6060-### Example Entry
6161-6262-```json
6363-{
6464- "url": "https://pds.myserver.com",
6565- "supportedHandles": [
6666- "*.myserver.com",
6767- "*.myserver.org"
6868- ],
6969- "maintainer": "@admin.myserver.com",
7070- "contactEmail": "admin@myserver.com",
7171- "tosUrl": "https://pds.myserver.com/terms-of-service",
7272- "privacyUrl": "https://pds.myserver.com/privacy-policy",
7373- "inviteCodeRequired": true
7474-}
7575-```
7676-7777-## Adding Your PDS
7878-7979-We welcome additions to the directory! There are two ways to add your PDS:
8080-8181-### Option 1: Submit a Tangled Issue
8282-8383-1. Go to the [Issues](https://tangled.org/madebydanny.uk/pdslist/issues/new) page
8484-2. Click "New Issue"
8585-3. Add your PDS information:
8686- - PDS URL
8787- - Supported handles
8888- - Your maintainer handle
8989- - Contact email (optional)
9090- - Terms of Service URL (if available)
9191- - Privacy Policy URL (if available)
9292- - Whether invite codes are required
9393-4. Submit the issue
9494-9595-A maintainer will review your submission and add it to the list.
9696-9797-### Option 2: Submit a Pull Request
9898-9999-1. Fork this repository
100100-2. Edit `pdslist.json`
101101-3. Add your PDS entry to the array following the structure above
102102-4. Ensure your JSON is valid (use a JSON validator)
103103-5. Commit your changes with a clear message: `Add [your-pds-name] to directory`
104104-6. Create a Pull Request with:
105105- - A clear title: "Add [your PDS name]"
106106- - Description of your PDS
107107- - Confirmation that you maintain the server
108108-109109-### Submission Guidelines
110110-111111-✅ **Do:**
112112-- Use valid JSON formatting
113113-- Include all required fields
114114-- Use HTTPS URLs only
115115-- Provide accurate information
116116-- Test your PDS is accessible before submitting
117117-118118-❌ **Don't:**
119119-- Submit inactive or offline servers
120120-- Include test or development servers
121121-- Use HTTP (non-secure) URLs
122122-- Submit duplicate entries
123123-124124-## Review Process
125125-126126-All submissions are reviewed by maintainers to ensure:
127127-- JSON is properly formatted
128128-- URLs are accessible and valid
129129-- Information is accurate
130130-- The PDS is actively maintained
131131-- Terms and privacy policies exist (if links provided)
132132-133133-## Updating Your Entry
134134-135135-If you need to update your PDS information:
136136-137137-1. Submit an issue with "Update [your-pds-name]" as the title
138138-2. Or create a Pull Request with the updated information
139139-140140-## Removing Your Entry
141141-142142-To remove your PDS from the directory:
143143-144144-1. Submit an issue with "Remove [your-pds-name]" as the title
145145-2. Or create a Pull Request removing your entry
146146-147147-## Code of Conduct
148148-149149-Please be respectful and professional in all interactions. This is a community resource for everyone.
150150-151151-## License
152152-153153-This project is open source and available for anyone to use and contribute to.
154154-155155-## Support
156156-157157-For questions or issues:
158158-- Open a Tangled Issue
159159-- Check existing issues for similar questions
160160-161161----
162162-163163-**Note:** This is a community-maintained list. We cannot guarantee the availability, security, or policies of listed servers. Always review a server's terms and privacy policy before joining.