mirror of
https://git.sr.ht/~tsileo/microblog.pub
synced 2024-11-15 03:04:28 +00:00
Tweak the README
This commit is contained in:
parent
395fec012b
commit
aa9ca2d868
1 changed files with 8 additions and 36 deletions
44
README.md
44
README.md
|
@ -17,37 +17,11 @@
|
||||||
|
|
||||||
**Still in early development.**
|
**Still in early development.**
|
||||||
|
|
||||||
## Perform the "drop-celery" migration
|
## /!\ Note to adventurer
|
||||||
|
|
||||||
The project is dropping Celery/RabbitMQ in favor of [poussetaches](https://github.com/tsileo/poussetaches), written specifically for microblog.pub.
|
If you are running an instance with Celery/RabbitMQ, you will need to [perform a migration](https://github.com/tsileo/microblog.pub/tree/drop-celery#perform-the-drop-celery-migration).
|
||||||
|
|
||||||
First you need to know your Docker compose project name, it should be the name of the project directory, without dot.
|
Getting closer to a stable release, it should be the "last" migration.
|
||||||
If you haven't renamed the directory it should be `microblogpub`.
|
|
||||||
If you're not sure you can run `$ docker-compose ps`, and get `{project_name}_{service}_{version}` in the output, like `microblogpub_web_1`
|
|
||||||
|
|
||||||
Generate a secret for poussetaches (you can use whatever secret you want):
|
|
||||||
|
|
||||||
```
|
|
||||||
$ python -c "import os, binascii; print(binascii.hexlify(os.urandom(32)).decode())"
|
|
||||||
```
|
|
||||||
|
|
||||||
Update the `.env` file and append:
|
|
||||||
|
|
||||||
```
|
|
||||||
POUSSETACHES_AUTH_KEY=yourgeneratedsecret
|
|
||||||
COMPOSE_PROJECT_NAME=microblogpub
|
|
||||||
```
|
|
||||||
|
|
||||||
Then switch to the `drop-celery` branch:
|
|
||||||
|
|
||||||
```
|
|
||||||
$ git checkout drop-celery
|
|
||||||
# Build the poussetaches container
|
|
||||||
$ make poussetaches
|
|
||||||
$ make update
|
|
||||||
```
|
|
||||||
|
|
||||||
And you should be good!
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
@ -74,11 +48,11 @@ And you should be good!
|
||||||
- You can setup a "purge" hook to let you invalidate cache when the microblog was updated
|
- You can setup a "purge" hook to let you invalidate cache when the microblog was updated
|
||||||
- Deployable with Docker (Docker compose for everything: dev, test and deployment)
|
- Deployable with Docker (Docker compose for everything: dev, test and deployment)
|
||||||
- Focused on testing
|
- Focused on testing
|
||||||
- The core ActivityPub code/tests are in [Little Boxes](https://github.com/tsileo/little-boxes)
|
|
||||||
- Tested against the [official ActivityPub test suite](https://test.activitypub.rocks/) ([report submitted](https://github.com/w3c/activitypub/issues/308))
|
- Tested against the [official ActivityPub test suite](https://test.activitypub.rocks/) ([report submitted](https://github.com/w3c/activitypub/issues/308))
|
||||||
- CI runs "federation" tests against two instances
|
- [CI runs "federation" tests against two instances](https://d.a4.io/tsileo/microblog.pub)
|
||||||
- Manually tested against [Mastodon](https://github.com/tootsuite/mastodon)
|
|
||||||
- Project is running an up-to-date instance
|
- Project is running an up-to-date instance
|
||||||
|
- The core ActivityPub code/tests are in [Little Boxes](https://github.com/tsileo/little-boxes)
|
||||||
|
- Manually tested against [Mastodon](https://github.com/tootsuite/mastodon)
|
||||||
|
|
||||||
## ActivityPub
|
## ActivityPub
|
||||||
|
|
||||||
|
@ -120,10 +94,8 @@ pass: $2b$12$iW497g...
|
||||||
|
|
||||||
### Deployment
|
### Deployment
|
||||||
|
|
||||||
Note: some of the docker yml files use version 3 of [docker-compose](https://docs.docker.com/compose/install/).
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ docker-compose up -d
|
$ make update
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
@ -134,7 +106,7 @@ The most convenient way to hack on microblog.pub is to run the server locally, a
|
||||||
```shell
|
```shell
|
||||||
# One-time setup
|
# One-time setup
|
||||||
$ pip install -r requirements.txt
|
$ pip install -r requirements.txt
|
||||||
# Start the Celery worker, RabbitMQ and MongoDB
|
# Start MongoDB and poussetaches
|
||||||
$ docker-compose -f docker-compose-dev.yml up -d
|
$ docker-compose -f docker-compose-dev.yml up -d
|
||||||
# Run the server locally
|
# Run the server locally
|
||||||
$ FLASK_DEBUG=1 MICROBLOGPUB_DEBUG=1 FLASK_APP=app.py flask run -p 5005 --with-threads
|
$ FLASK_DEBUG=1 MICROBLOGPUB_DEBUG=1 FLASK_APP=app.py flask run -p 5005 --with-threads
|
||||||
|
|
Loading…
Reference in a new issue