No Description

default 1167b64f8f mastoapi: minor tweak to notification list (Tusky was in a forever request loop). 1 day ago
artwork 294675ae9a Moved avatars to artwork/. 1 year ago
doc 29ac9156e2 Updated documentation. 1 day ago
examples 41081dd0d5 examples: add instructions to statically link snac with musl libc 1 week ago
.gitignore 0cdd193be9 [.gitignore] new file. 2 years ago
Dockerfile 89f6924ae2 Improve Docker image generation 2 years ago
LICENSE 755d997fb1 Updated copyright year. 11 months ago
Makefile b6107c8777 Makefile: enable static compilation with musl 1 month ago
Makefile.NetBSD 000db2c1e4 Updated dependencies. 1 month ago
README.md 8c26debb9d Fixed URL in README.md. 2 months ago
RELEASE_NOTES.md 55fb7dcbef Updated RELEASE_NOTES. 1 day ago
TODO.md 4daacf6b9d Updated TODO. 1 month ago
activitypub.c 13d4fde316 Avoid adding repeated attachments. 2 days ago
data.c 156d528019 Add contact metrics to og:description. 1 day ago
docker-compose.yaml 4afa513dce Add docker-compose support, so a working development server with HTTPS can be started with: 2 years ago
format.c 13d4fde316 Avoid adding repeated attachments. 2 days ago
html.c 156d528019 Add contact metrics to og:description. 1 day ago
http.c 8cf7559a7e Added more const. 7 months ago
http_codes.h 25ef07b1ec More or less smaller fixes :) 6 months ago
httpd.c b9e0c6e742 Added pidfile locking. 4 days ago
main.c a30b2b61b4 Fixed typo. 3 weeks ago
mastoapi.c 1167b64f8f mastoapi: minor tweak to notification list (Tusky was in a forever request loop). 1 day ago
snac.c 19b9998f8c The proxy token seed is created on startup and never stored. 1 month ago
snac.h fa253f008a Implement mastoapi markers for notifications and home. 1 day ago
upgrade.c 8cf7559a7e Added more const. 7 months ago
utils.c b3be8e0673 New cmdline ops 'import_list' and 'import_block_list'. 3 weeks ago
webfinger.c bde5748a6e Minor webfinger tweak. 2 days ago
xs.h 12373b018e Added -pedantic compilation flag. 2 months ago
xs_curl.h 0218e964b0 Backport from xs. 3 months ago
xs_fcgi.h f82c7a5cdb Propagate FastCGI variable REMOTE_ADDR. 2 days ago
xs_glob.h 1675127c2a Minor xs tweak. 1 month ago
xs_hex.h 755d997fb1 Updated copyright year. 11 months ago
xs_html.h 4777fc86cb Added const everywhere. 7 months ago
xs_httpd.h a6bf1ee0d0 Use the raw_path for proxying (as some media may include ? arguments). 1 month ago
xs_io.h 755d997fb1 Updated copyright year. 11 months ago
xs_json.h 31ce1af736 Minor code cleaning. 3 months ago
xs_match.h 755d997fb1 Updated copyright year. 11 months ago
xs_mime.h 2a29fc102e Added image/avif mime type. 2 weeks ago
xs_openssl.h 755d997fb1 Updated copyright year. 11 months ago
xs_random.h 12373b018e Added -pedantic compilation flag. 2 months ago
xs_regex.h 0218e964b0 Backport from xs. 3 months ago
xs_set.h 2d2a685ec8 More migration work. 3 months ago
xs_socket.h 972c3dc5d4 Added support for listening on unix sockets. 4 months ago
xs_time.h 1675127c2a Minor xs tweak. 1 month ago
xs_unicode.h c507e30607 New function xs_unicode_right_to_left(). 1 month ago
xs_unicode_tbl.h c507e30607 New function xs_unicode_right_to_left(). 1 month ago
xs_unix_socket.h 755fdbd737 Variable renaming in xs_unix_socket, because it collides in Illumos. 4 months ago
xs_url.h a5a7ab9ba5 Backport from xs. 3 weeks ago
xs_version.h a5a7ab9ba5 Backport from xs. 3 weeks ago

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
  • 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 gives compilation errors (because your system does not implement the shared memory functions), you can fix it 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)

Links of Interest

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