mirror of
https://codeberg.org/grunfink/snac2.git
synced 2024-11-22 05:15:04 +00:00
Minor README tweak.
This commit is contained in:
parent
11c7d6ebff
commit
8983eb141d
1 changed files with 6 additions and 6 deletions
12
README.md
12
README.md
|
@ -2,7 +2,7 @@
|
|||
|
||||
A simple, minimalistic ActivityPub instance
|
||||
|
||||
# Features
|
||||
## Features
|
||||
|
||||
- Lightweight, minimal dependencies
|
||||
- Extensive support of ActivityPub operations, e.g. write public notes, follow users, be followed, reply to the notes of others, admire wonderful content (like or boost), write private messages...
|
||||
|
@ -15,7 +15,7 @@ A simple, minimalistic ActivityPub instance
|
|||
- No cookies either
|
||||
- Not much bullshit
|
||||
|
||||
# About
|
||||
## About
|
||||
|
||||
This program runs as a daemon (proxied by a TLS-enabled real httpd server) and provides the basic services for a Fediverse / ActivityPub instance (sharing messages and stuff from/to other systems like Mastodon, Pleroma, Friendica, etc.).
|
||||
|
||||
|
@ -23,7 +23,7 @@ This is not the manual; man pages `snac(1)` (user manual), `snac(5)` (formats) a
|
|||
|
||||
`snac` stands for Social Networks Are Crap.
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
This 2.x release is written in C (unlike the 1.x prototype, which was written in Python). The only external dependencies are `openssl` and `curl`.
|
||||
|
||||
|
@ -43,7 +43,7 @@ Run `make` and then `make install` as root.
|
|||
|
||||
See the administrator manual on how to proceed from here.
|
||||
|
||||
# Testing via Docker
|
||||
## Testing via Docker
|
||||
|
||||
A `docker-compose` file is provided for development and testing. To start snac with an nginx HTTPS frontend, run:
|
||||
|
||||
|
@ -56,10 +56,10 @@ This will:
|
|||
- Create a new user `testuser` and print the user's generated password on the console (see `examples/docker-entrypoint.sh`)
|
||||
- Start nginx to handle HTTPS, using the certificate pair from `nginx-alpine-ssl/nginx-selfsigned.*` (see `examples/nginx-alpine-ssl/entrypoint.sh`)
|
||||
|
||||
# License
|
||||
## License
|
||||
|
||||
See the LICENSE file for details.
|
||||
|
||||
# Author
|
||||
## Author
|
||||
|
||||
grunfink @grunfink@comam.es
|
||||
|
|
Loading…
Reference in a new issue