Minimalistic ActivityPub server
Go to file
2024-05-21 18:57:13 +02:00
artwork Moved avatars to artwork/. 2023-08-04 19:16:09 +02:00
doc Updated documentation. 2024-04-22 08:03:33 +02:00
examples Addes NetBSD rc script example 2024-01-07 19:41:43 +00:00
.gitignore [.gitignore] new file. 2022-09-27 09:06:03 +02:00
activitypub.c Added const everywhere. 2024-05-21 14:12:15 +02:00
data.c Added const everywhere. 2024-05-21 14:12:15 +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 Add some special treatment to Event object display. 2024-05-11 19:35:33 +02:00
html.c Added const everywhere. 2024-05-21 14:12:15 +02:00
http.c Added const everywhere. 2024-05-21 14:12:15 +02:00
httpd.c New compilation variable WITHOUT_SHM, to disable shared memory functions. 2024-05-21 18:57:13 +02:00
LICENSE Updated copyright year. 2024-01-04 09:22:03 +01:00
main.c Added const everywhere. 2024-05-21 14:12:15 +02:00
Makefile Updated dependencies. 2024-05-09 09:32:43 +02:00
Makefile.NetBSD Updated dependencies. 2024-05-09 09:32:43 +02:00
mastoapi.c Added const everywhere. 2024-05-21 14:12:15 +02:00
README.md New compilation variable WITHOUT_SHM, to disable shared memory functions. 2024-05-21 18:57:13 +02:00
RELEASE_NOTES.md Updated RELEASE_NOTES. 2024-05-15 07:52:35 +02:00
snac.c Updated copyright year. 2024-01-04 09:22:03 +01:00
snac.h Added const everywhere. 2024-05-21 14:12:15 +02:00
TODO.md Updated TODO. 2024-05-12 08:57:38 +02:00
upgrade.c Added const everywhere. 2024-05-21 14:12:15 +02:00
utils.c Added const everywhere. 2024-05-21 14:12:15 +02:00
webfinger.c Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_curl.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_fcgi.h Backport from xs. 2024-03-09 08:32:20 +01:00
xs_glob.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_hex.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_html.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_httpd.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_io.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_json.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_match.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_mime.h Backport from xs. 2024-04-14 19:26:49 +02:00
xs_openssl.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_random.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_regex.h Use xs_regex_match() where applicable. 2024-05-15 13:27:23 +02:00
xs_set.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_socket.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_time.h Updated copyright year. 2024-01-04 09:22:03 +01:00
xs_unicode.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_url.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs_version.h Added const everywhere. 2024-05-21 14:12:15 +02:00
xs.h Added const everywhere. 2024-05-21 14:12:15 +02:00

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
  • 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 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

On FreeBSD, to install curl just type:

pkg install curl

On NetBSD, to install curl just type:

pkgin install curl

The source code is available here.

Run make and then make install as root.

If you're compiling on NetBSD, you should use the specific provided Makefile and run make -f Makefile.NetBSD and then make -f Makefile.NetBSD 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

If your compilation process complains about undefined references to shm_open() and shm_unlink() (it happens, for example, on Ubuntu 20.04.6 LTS), run it as:

make LDFLAGS=-lrt

If it still doesn't work (because your system does not implement the shared memory functions) or you are just not interested, you can compile out with

make CFLAGS=-DWITHOUT_SHM

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)

Incredibly awesome CSS themes for snac

License

See the LICENSE file for details.

Author

grunfink @grunfink@comam.es with the help of others.

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