diff options
| author |  default | 2023-02-05 11:23:10 +0100 |
|---|---|---|
| committer | default | 2023-02-05 11:23:10 +0100 |
| commit | 8983eb141db47a9f86e64523bfea6ca355ad4e7b (patch) | |
| tree | 2dd27390772c116bdc46ca846c3ebbc9f1f54c48 /README.md | |
| parent | Version 2.20 RELEASED. (diff) | |
| download | penes-snac2-8983eb141db47a9f86e64523bfea6ca355ad4e7b.tar.gz penes-snac2-8983eb141db47a9f86e64523bfea6ca355ad4e7b.tar.xz penes-snac2-8983eb141db47a9f86e64523bfea6ca355ad4e7b.zip | |
Minor README tweak.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 6 insertions, 6 deletions
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | A simple, minimalistic ActivityPub instance | 3 | A simple, minimalistic ActivityPub instance |
| 4 | 4 | ||
| 5 | # Features | 5 | ## Features |
| 6 | 6 | ||
| 7 | - Lightweight, minimal dependencies | 7 | - Lightweight, minimal dependencies |
| 8 | - 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... | 8 | - 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 | |||
| 15 | - No cookies either | 15 | - No cookies either |
| 16 | - Not much bullshit | 16 | - Not much bullshit |
| 17 | 17 | ||
| 18 | # About | 18 | ## About |
| 19 | 19 | ||
| 20 | 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.). | 20 | 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.). |
| 21 | 21 | ||
| @@ -23,7 +23,7 @@ This is not the manual; man pages `snac(1)` (user manual), `snac(5)` (formats) a | |||
| 23 | 23 | ||
| 24 | `snac` stands for Social Networks Are Crap. | 24 | `snac` stands for Social Networks Are Crap. |
| 25 | 25 | ||
| 26 | # Installation | 26 | ## Installation |
| 27 | 27 | ||
| 28 | 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`. | 28 | 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`. |
| 29 | 29 | ||
| @@ -43,7 +43,7 @@ Run `make` and then `make install` as root. | |||
| 43 | 43 | ||
| 44 | See the administrator manual on how to proceed from here. | 44 | See the administrator manual on how to proceed from here. |
| 45 | 45 | ||
| 46 | # Testing via Docker | 46 | ## Testing via Docker |
| 47 | 47 | ||
| 48 | A `docker-compose` file is provided for development and testing. To start snac with an nginx HTTPS frontend, run: | 48 | A `docker-compose` file is provided for development and testing. To start snac with an nginx HTTPS frontend, run: |
| 49 | 49 | ||
| @@ -56,10 +56,10 @@ This will: | |||
| 56 | - Create a new user `testuser` and print the user's generated password on the console (see `examples/docker-entrypoint.sh`) | 56 | - Create a new user `testuser` and print the user's generated password on the console (see `examples/docker-entrypoint.sh`) |
| 57 | - Start nginx to handle HTTPS, using the certificate pair from `nginx-alpine-ssl/nginx-selfsigned.*` (see `examples/nginx-alpine-ssl/entrypoint.sh`) | 57 | - Start nginx to handle HTTPS, using the certificate pair from `nginx-alpine-ssl/nginx-selfsigned.*` (see `examples/nginx-alpine-ssl/entrypoint.sh`) |
| 58 | 58 | ||
| 59 | # License | 59 | ## License |
| 60 | 60 | ||
| 61 | See the LICENSE file for details. | 61 | See the LICENSE file for details. |
| 62 | 62 | ||
| 63 | # Author | 63 | ## Author |
| 64 | 64 | ||
| 65 | grunfink @grunfink@comam.es | 65 | grunfink @grunfink@comam.es |