aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
blob: 9a8185fd1826cf90e4b3e3e56b62916e9b3487f7 (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
31
32
33
34
35
36
37
38
# digitigrade

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

## running the server

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

whenever you want to update to the latest version (from git) you should:

1. run `git pull`
2. if there were any changes to composer.json/composer.lock, run
   `composer install` (if you're not sure it can't hurt to run it just in case)
3. run `bin/migrate`
4. hope it works :3

if it looks messed up in your web browser after updating, you should be able
to fix it by force reloading the page once