No Description

Florian Paul Azim Hoberg a0846fbc74 docs(README.md): Add link to FreeBSD installation guide 1 year ago
artwork 294675ae9a Moved avatars to artwork/. 1 year ago
doc 29f2160b58 Merge branch 'master' of grunfink-codeberg:grunfink/snac2 1 year ago
examples 4d9a19f3bf Addes NetBSD rc script example 1 year ago
.gitignore 0cdd193be9 [.gitignore] new file. 2 years ago
Dockerfile 89f6924ae2 Improve Docker image generation 2 years ago
LICENSE 755d997fb1 Updated copyright year. 1 year ago
Makefile 6c556581e0 Rewritten a sentence to be clearer in README.md. 1 year ago
Makefile.NetBSD 0414dfae20 Added Makefile.NetBSD to compile on NetBSD 1 year ago
README.md a0846fbc74 docs(README.md): Add link to FreeBSD installation guide 1 year ago
RELEASE_NOTES.md 6ae84c9596 Updated RELEASE_NOTES. 1 year ago
TODO.md ffa943a182 Updated TODO. 1 year ago
activitypub.c 199d71dc3a Skip our own notifications. 1 year ago
data.c 80c31a2e01 Deactivated stale actors behind a compiler directive. 1 year 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 33a0386a1e In posts, fixed bad link urls if written between parentheses. 1 year ago
html.c 5702e2592f Made descs a bit longer. 1 year ago
http.c 755d997fb1 Updated copyright year. 1 year ago
httpd.c 644138b2b9 Minor tweak to host-meta. 1 year ago
main.c fdb32864aa New command-line option 'state'. 1 year ago
mastoapi.c 151c5aa6ec mastoapi: Skip non-public posts from timelines by tag. 1 year ago
snac.c 755d997fb1 Updated copyright year. 1 year ago
snac.h 4e35b4b865 Added paging to notify_list(), and use it in the notifications page. 1 year ago
upgrade.c 755d997fb1 Updated copyright year. 1 year ago
utils.c ceda5bab31 Also add dark mode CSS to utils.c. 1 year ago
webfinger.c 7f6a793146 Fixed minor collision in webfinger caching. 1 year ago
xs.h 3d1f6049e2 Backport from xs. 1 year ago
xs_curl.h 755d997fb1 Updated copyright year. 1 year ago
xs_fcgi.h 755d997fb1 Updated copyright year. 1 year ago
xs_glob.h 755d997fb1 Updated copyright year. 1 year ago
xs_hex.h 755d997fb1 Updated copyright year. 1 year ago
xs_html.h 755d997fb1 Updated copyright year. 1 year ago
xs_httpd.h 755d997fb1 Updated copyright year. 1 year ago
xs_io.h 755d997fb1 Updated copyright year. 1 year ago
xs_json.h 755d997fb1 Updated copyright year. 1 year ago
xs_match.h 755d997fb1 Updated copyright year. 1 year ago
xs_mime.h 755d997fb1 Updated copyright year. 1 year ago
xs_openssl.h 755d997fb1 Updated copyright year. 1 year ago
xs_random.h 755d997fb1 Updated copyright year. 1 year ago
xs_regex.h 755d997fb1 Updated copyright year. 1 year ago
xs_set.h 755d997fb1 Updated copyright year. 1 year ago
xs_socket.h 755d997fb1 Updated copyright year. 1 year ago
xs_time.h 755d997fb1 Updated copyright year. 1 year ago
xs_unicode.h 755d997fb1 Updated copyright year. 1 year ago
xs_url.h 755d997fb1 Updated copyright year. 1 year ago
xs_version.h aa1524be71 Better behaviour on broken queue items. 1 year 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

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