monkee.ch/snac2
1
0
Fork 0
mirror of https://codeberg.org/grunfink/snac2.git synced 2024-12-25 16:53:37 +00:00
Code Issues Projects Releases Packages Wiki Activity
A simple, minimalistic ActivityPub instance written in portable C
1309 commits 1 branch 67 tags 17 MiB
C 99.6%
Makefile 0.3%
Find a file
grunfink 08e43f2093 Merge pull request 'Reformat the codeblocks in README.md' (#35) from bouncepaw/snac2:master into master 
Reviewed-on: https://codeberg.org/grunfink/snac2/pulls/35
2023-05-13 15:46:02 +00:00
doc Updated documentation. 2023-05-08 10:16:30 +02:00
examples Updated examples/docket-entrypoint.sh. 2023-05-05 12:58:54 +02:00
.gitignore [.gitignore] new file. 2022-09-27 09:06:03 +02:00
activitypub.c Use a different approach towards incomplete mentions. 2023-05-12 19:01:53 +02:00
data.c Added a source (web, mastoapi, etc) to lastlog_write(). 2023-05-08 09:02:45 +02:00
docker-compose.yaml Add docker-compose support, so a working development server with HTTPS can be started with: 2022-12-12 10:26:38 +00:00
Dockerfile Improve Docker image generation 2022-12-14 11:46:16 +01:00
format.c Updated documentation. 2023-03-08 04:47:57 +01:00
html.c Only show the bio in the top of the page for public pages. 2023-05-13 09:35:43 +02:00
http.c Use xs_replace_n() where it suits. 2023-05-02 06:49:00 +02:00
httpd.c Fixed conflict. 2023-05-09 17:22:31 +02:00
LICENSE Updated year in copyright notices. 2023-01-17 09:50:16 +01:00
main.c Added a source (web, mastoapi, etc) to lastlog_write(). 2023-05-08 09:02:45 +02:00
Makefile Print the total running time at httpd stop. 2023-05-08 09:34:27 +02:00
mastoapi.c Added more comment marks. 2023-05-12 13:06:38 +02:00
README.md Reformat the codeblocks in README.md 2023-05-13 15:08:30 +00:00
RELEASE_NOTES.md Updated RELEASE_NOTES. 2023-05-13 09:19:23 +02:00
snac.c Backport from xs. 2023-05-09 14:18:15 +02:00
snac.h Version 2.31 RELEASED. 2023-05-13 16:56:06 +02:00
TODO.md Updated TODO. 2023-04-24 05:04:15 +02:00
upgrade.c New utility function mkdirx(). 2023-02-07 09:25:01 +01:00
utils.c Fill the mastoapi instance contact_account field, if possible. 2023-05-08 10:13:43 +02:00
webfinger.c Merge branch 'master' of grunfink-codeberg:grunfink/snac2 2023-05-13 09:17:35 +02:00
xs.h Backport from xs. 2023-05-02 06:41:45 +02:00
xs_curl.h Fixed webfinger and curl issues 2023-05-07 13:42:47 +08:00
xs_encdec.h Backport from xs. 2023-05-09 14:23:30 +02:00
xs_glob.h Backport from xs. 2023-01-28 17:49:02 +01:00
xs_httpd.h Backport from xs. 2023-05-11 10:48:37 +02:00
xs_io.h Backport from xs. 2023-01-28 17:49:02 +01:00
xs_json.h Backport from xs. 2023-04-19 22:53:07 +02:00
xs_mime.h Updated year in copyright notices. 2023-01-17 09:50:16 +01:00
xs_openssl.h Backport from xs. 2023-05-11 10:48:37 +02:00
xs_regex.h Backport from xs. 2023-01-28 17:49:02 +01:00
xs_set.h Backport from xs. 2023-01-28 17:49:02 +01:00
xs_socket.h Backport from xs. 2023-03-08 04:28:20 +01:00
xs_time.h Backport from xs. 2023-05-08 09:30:26 +02:00
xs_unicode.h Backport from xs. 2023-05-09 14:18:15 +02:00
xs_version.h Backport from xs. 2023-05-11 10:48:37 +02:00

README.md

snac

A simple, minimalistic ActivityPub instance

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...
  • Multiuser
  • Mastodon API support, so Mastodon-compatible apps can be used (work in progress)
  • Simple but effective web interface
  • Easily-accessed MUTE button to silence morons
  • Tested interoperability with related software
  • No database needed
  • Totally JavaScript-free
  • No cookies either
  • Not much bullshit

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.).

This is not the manual; man pages snac(1) (user manual), snac(5) (formats) and snac(8) (administrator manual) are what you are looking for.

snac stands for Social Networks Are Crap.

Building and installation

This program is written in highly portable ANSI C. The only external dependencies are openssl and curl.

On Debian/Ubuntu, you can satisfy these requirements by running

apt install libssl-dev libcurl4-openssl-dev

On OpenBSD you just need to install curl:

pkg_add curl

Run make and then make install as root.

From version 2.27, snac includes support for the Mastodon API; if you are not interested on it, you can compile it out by running

make CFLAGS=-DNO_MASTODON_API

See the administrator manual on how to proceed from here.

Testing via Docker

A docker-compose file is provided for development and testing. To start snac with an nginx HTTPS frontend, run:

docker-compose build && docker-compose up

This will:

  • Start snac, storing data in data/
  • Configure snac to listen on port 8001 with a server name of localhost (see examples/docker-entrypoint.sh)
  • 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

See the LICENSE file for details.

Author

grunfink @grunfink@comam.es

Buy grunfink a coffee: https://ko-fi.com/grunfink