Ei kuvausta

Louis Brauer 26fbda787d Translate status codes to canonical status texts 2 vuotta sitten
artwork 294675ae9a Moved avatars to artwork/. 3 vuotta sitten
doc 36969bcf6f Updated documentation. 2 vuotta sitten
examples 4d9a19f3bf Addes NetBSD rc script example 2 vuotta sitten
.gitignore 0cdd193be9 [.gitignore] new file. 4 vuotta sitten
Dockerfile 89f6924ae2 Improve Docker image generation 3 vuotta sitten
LICENSE 755d997fb1 Updated copyright year. 2 vuotta sitten
Makefile 7b0e9285af Updated dependencies. 2 vuotta sitten
Makefile.NetBSD 7b0e9285af Updated dependencies. 2 vuotta sitten
README.md c9c9b0bfdc Updated README. 2 vuotta sitten
RELEASE_NOTES.md fbdcbc8414 Updated RELEASE_NOTES. 2 vuotta sitten
TODO.md 61b9ad8ee5 Updated TODO. 2 vuotta sitten
activitypub.c 0e21d35e80 Use enum instead of numeric status codes for HTTP statuses 2 vuotta sitten
data.c 81cf309e4d Implement Mastodon PATCH endpoint for account profile updates 2 vuotta sitten
docker-compose.yaml 4afa513dce Add docker-compose support, so a working development server with HTTPS can be started with: 3 vuotta sitten
format.c 36764b8ade Minor tweak to markdown-like links. 2 vuotta sitten
html.c 4621a25ba4 Merge remote-tracking branch 'origin/master' 2 vuotta sitten
http.c 8cf7559a7e Added more const. 2 vuotta sitten
http_codes.h 26fbda787d Translate status codes to canonical status texts 2 vuotta sitten
httpd.c 26fbda787d Translate status codes to canonical status texts 2 vuotta sitten
main.c 8cf7559a7e Added more const. 2 vuotta sitten
mastoapi.c 81cf309e4d Implement Mastodon PATCH endpoint for account profile updates 2 vuotta sitten
snac.c 26fbda787d Translate status codes to canonical status texts 2 vuotta sitten
snac.h 26fbda787d Translate status codes to canonical status texts 2 vuotta sitten
upgrade.c 8cf7559a7e Added more const. 2 vuotta sitten
utils.c 8cf7559a7e Added more const. 2 vuotta sitten
webfinger.c 0e21d35e80 Use enum instead of numeric status codes for HTTP statuses 2 vuotta sitten
xs.h 637a88fb0f Use ISO C99 __func__ instead of GNU __FUNCTION__ 2 vuotta sitten
xs_curl.h 8cf7559a7e Added more const. 2 vuotta sitten
xs_fcgi.h 8cf7559a7e Added more const. 2 vuotta sitten
xs_glob.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_hex.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_html.h 4777fc86cb Added const everywhere. 2 vuotta sitten
xs_httpd.h 26fbda787d Translate status codes to canonical status texts 2 vuotta sitten
xs_io.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_json.h 8cf7559a7e Added more const. 2 vuotta sitten
xs_match.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_mime.h 0275658a36 Backport from xs. 2 vuotta sitten
xs_openssl.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_random.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_regex.h a292080000 Backport from xs (fix regex.h compilation with tcc). 2 vuotta sitten
xs_set.h a292080000 Backport from xs (fix regex.h compilation with tcc). 2 vuotta sitten
xs_socket.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_time.h 755d997fb1 Updated copyright year. 2 vuotta sitten
xs_unicode.h 4777fc86cb Added const everywhere. 2 vuotta sitten
xs_url.h a292080000 Backport from xs (fix regex.h compilation with tcc). 2 vuotta sitten
xs_version.h 36764b8ade Minor tweak to markdown-like links. 2 vuotta sitten

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