aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: b80f14079093d77d90f7dffe67a137f698dbfa77 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
# digitigrade

an experimental server for the also-experimental pawpub federated social media
protocol.

## running the server

**it is not in a usable state yet!** nothing useful will happen by running it,
unless you're working on it.

you should have:

* php >= 8.3 with the `pdo_pgsql` and `sockets` extensions
* composer
* a postgres server, database and user already set up
* a beanstalkd server already running

the basic steps for setup are:

1. run `bin/init` (which will install composer things and update the internal
   version info)
2. edit config.ini as appropriate
3. set up the database with `bin/migrate`
4. run the development server with `bin/devserver <port>`, or set it up with
   fpm in your web server
5. run at least one worker with `bin/worker`
6. create an account for yourself using `bin/newuser`

you can poke around with `bin/shell` which will launch the interactive php
shell and initialise all the composer autoloads and so on