danielmorrisey.com
-126
README.md
-126
README.md
···
35
35
Open source and community-maintained. For questions, open an issue
36
36
37
37
**Disclaimer:** This is a community list. Always review server terms and privacy policies before joining.
38
-
{
39
-
"url": "https://ypds.example.com",
40
-
"supportedHandles": ["*.example.com", "*.example.net"],
41
-
"maintainer": "@your-handle.example.com",
42
-
"tosUrl": "https://pds.example.com/terms",
43
-
"privacyUrl": "https://pds.example.com/privacy",
44
-
"inviteCodeRequired": false
45
-
}
46
-
```
47
-
48
-
### Field Descriptions
49
-
50
-
| Field | Type | Required | Description |
51
-
|-------|------|----------|-------------|
52
-
| `url` | string | ✅ Yes | The base URL of your PDS server (must include https://) |
53
-
| `supportedHandles` | array of strings | ✅ Yes | Domain patterns for handles your PDS supports (e.g., `*.example.com`) |
54
-
| `maintainer` | string | ✅ Yes | Bluesky handle of the server maintainer (format: `@handle.domain.com`) |
55
-
| `contactEmail` | string | ⚠️ Optional | Contact email for the PDS administrator |
56
-
| `tosUrl` | string | ⚠️ Optional | URL to your Terms of Service page |
57
-
| `privacyUrl` | string | ⚠️ Optional | URL to your Privacy Policy page |
58
-
| `inviteCodeRequired` | boolean | ✅ Yes | Whether new users need an invite code to join (`true` or `false`) |
59
-
60
-
### Example Entry
61
-
62
-
```json
63
-
{
64
-
"url": "https://pds.myserver.com",
65
-
"supportedHandles": [
66
-
"*.myserver.com",
67
-
"*.myserver.org"
68
-
],
69
-
"maintainer": "@admin.myserver.com",
70
-
"contactEmail": "admin@myserver.com",
71
-
"tosUrl": "https://pds.myserver.com/terms-of-service",
72
-
"privacyUrl": "https://pds.myserver.com/privacy-policy",
73
-
"inviteCodeRequired": true
74
-
}
75
-
```
76
-
77
-
## Adding Your PDS
78
-
79
-
We welcome additions to the directory! There are two ways to add your PDS:
80
-
81
-
### Option 1: Submit a Tangled Issue
82
-
83
-
1. Go to the [Issues](https://tangled.org/madebydanny.uk/pdslist/issues/new) page
84
-
2. Click "New Issue"
85
-
3. Add your PDS information:
86
-
- PDS URL
87
-
- Supported handles
88
-
- Your maintainer handle
89
-
- Contact email (optional)
90
-
- Terms of Service URL (if available)
91
-
- Privacy Policy URL (if available)
92
-
- Whether invite codes are required
93
-
4. Submit the issue
94
-
95
-
A maintainer will review your submission and add it to the list.
96
-
97
-
### Option 2: Submit a Pull Request
98
-
99
-
1. Fork this repository
100
-
2. Edit `pdslist.json`
101
-
3. Add your PDS entry to the array following the structure above
102
-
4. Ensure your JSON is valid (use a JSON validator)
103
-
5. Commit your changes with a clear message: `Add [your-pds-name] to directory`
104
-
6. Create a Pull Request with:
105
-
- A clear title: "Add [your PDS name]"
106
-
- Description of your PDS
107
-
- Confirmation that you maintain the server
108
-
109
-
### Submission Guidelines
110
-
111
-
✅ **Do:**
112
-
- Use valid JSON formatting
113
-
- Include all required fields
114
-
- Use HTTPS URLs only
115
-
- Provide accurate information
116
-
- Test your PDS is accessible before submitting
117
-
118
-
❌ **Don't:**
119
-
- Submit inactive or offline servers
120
-
- Include test or development servers
121
-
- Use HTTP (non-secure) URLs
122
-
- Submit duplicate entries
123
-
124
-
## Review Process
125
-
126
-
All submissions are reviewed by maintainers to ensure:
127
-
- JSON is properly formatted
128
-
- URLs are accessible and valid
129
-
- Information is accurate
130
-
- The PDS is actively maintained
131
-
- Terms and privacy policies exist (if links provided)
132
-
133
-
## Updating Your Entry
134
-
135
-
If you need to update your PDS information:
136
-
137
-
1. Submit an issue with "Update [your-pds-name]" as the title
138
-
2. Or create a Pull Request with the updated information
139
-
140
-
## Removing Your Entry
141
-
142
-
To remove your PDS from the directory:
143
-
144
-
1. Submit an issue with "Remove [your-pds-name]" as the title
145
-
2. Or create a Pull Request removing your entry
146
-
147
-
## Code of Conduct
148
-
149
-
Please be respectful and professional in all interactions. This is a community resource for everyone.
150
-
151
-
## License
152
-
153
-
This project is open source and available for anyone to use and contribute to.
154
-
155
-
## Support
156
-
157
-
For questions or issues:
158
-
- Open a Tangled Issue
159
-
- Check existing issues for similar questions
160
-
161
-
---
162
-
163
-
**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.