retr0.id
1# millipds [WIP]
2A from-scratch atproto PDS implementation that dreams of becoming "production grade" software (it isn't, yet).
3
4millipds is a successor to [DavidBuchanan314/picopds](https://github.com/davidBuchanan314/picopds), which is even more minimalist, but hacky and no longer maintained.
5
6It works to the extent that it can "federate" with the rest of the atproto network, but there are a lot of rough edges still. I wouldn't currently recommend using it for anything other than testing or experimentation (although, due to the nature of atproto, if you don't like it you can seamlessly migrate your whole account elsewhere). Until millipds reaches v1.0.0, I reserve the right to make breaking DB schema changes without providing a migration path.
7
8It depends on [DavidBuchanan314/atmst](https://github.com/DavidBuchanan314/atmst) for implementing logic related to the Merkle Search Tree data structure, and [DavidBuchanan314/dag-cbrrr](https://github.com/DavidBuchanan314/dag-cbrrr) for DAG-CBOR parsing and serialisation.
9
10See https://github.com/DavidBuchanan314/millipds/issues/12 for an incomplete list of differences between this implementation and the [reference implementation](https://github.com/bluesky-social/atproto/tree/main/packages/pds).
11
12### Local dev install:
13
14```sh
15git clone https://github.com/DavidBuchanan314/millipds
16cd millipds
17python3 -m pip install -e .
18```
19
20### Dockerised dev install, via podman:
21
22(note: I have no idea what I'm doing with this!)
23
24```sh
25podman build -f millipds_dev.dockerfile -t millipds_dev
26podman run --rm -it -p 8123:8123 millipds_dev
27```
28
29### Production deployment on Ubuntu (and similar systems) [WIP]
30
31See [./docs/DEPLOY.md](./docs/DEPLOY.md)
32
33
34### Running the tests locally
35
36```sh
37python3 -m pip install -e .[test] # install the testing dependencies (only needed once, unless new deps are added)
38python3 -m pytest . # run the tests
39```