n9k
b1f5bbdecd
Before this, if a request was not coming from an existing user (no token in the request or no user with the given token), then and only then would we send the access captcha. This meant that if a user left a chat message and became absent, they wouldn't be prompted to do the access captcha again until their message was eventuallly rotated. (While messages exist we don't delete the users who posted them.) This commit makes it so if user['verified'] is None, the user is kicked and prompted with the access captcha. This is automatically done for absent users by a background task. |
||
|---|---|---|
| LICENSES | ||
| anonstream | ||
| .gitignore | ||
| HACKING.md | ||
| README.md | ||
| STREAMING.md | ||
| asgi.py | ||
| config.toml | ||
| emotes.json | ||
| requirements.txt | ||
| title.txt | ||
README.md
anonstream
Recipe for livestreaming over Tor
Repo
The canonical location of this repo is https://git.076.ne.jp/ninya9k/anonstream.
These mirrors also exist:
Setup
You must have Python 3.10 at a minimum. You can check your version of Python
with python --version.
Clone the repo:
git clone https://git.076.ne.jp/ninya9k/anonstream.git
cd anonstream
Install dependencies in a virtual environment:
python -m venv venv
source venv/bin/activate
python -m pip install -r requirements.txt
Before you run it you may want to edit the config (/config.toml). Most of the defaults are probably okay, but here are some that you might want to know what they do:
-
secret_key: used for cryptography, make it any long random string (e.g.$ dd if=/dev/urandom bs=16 count=1 | base64), definitely set this yourself before running in "production" (whatever that is for you) -
segments/directory: directory containing stream segments, the default isstream/in the cloned repository -
title/file: location of the stream title, the default istitle.txtin the cloned repository -
captcha/fonts: locations of fonts for the captcha, leaving it blank will use the default font -
access/captcha: if true, users must complete a captcha before accessing the site proper
Run it:
python -m anonstream
This will start a webserver listening on the local host at port 5051 (use
--port PORT to override).
If you go to http://localhost:5051 in a web browser now you should see
the site. When you started the webserver some credentials were printed
in the terminal; you can log in with those at
http://localhost:5051/login.
The only things left are (1) streaming, and (2) letting other people access your stream. /STREAMING.md has instructions for setting up OBS Studio and a Tor onion service. If you want to use different streaming software and put your stream on the Internet some other way, read those instructions and copy the gist.
Running
Start anonstream like this:
python -m anonstream
The default port is 5051. Append --help to see options.
If you want to use a different ASGI server, point it to the app factory
at asgi:create_app(). For example with uvicorn:
python -m uvicorn asgi:create_app --factory --port 5051
In either case you can explicitly set the location of the config file
using the ANONSTREAM_CONFIG environment variable.
Hacking
anonstream has APIs for accessing internal state and hooking into internal events. They can be used by humans and other programs. See /HACKING.md.
Copying
anonstream is AGPL 3.0 or later, see /LICENSES/AGPL-3.0-or-later.md.
Assets
- /anonstream/static/settings.svg: setting by ulimicon is licensed under CC BY 3.0.
Dependencies
-
aiofiles https://github.com/Tinche/aiofiles (Apache 2.0)
-
itsdangerous https://github.com/pallets/itsdangerous/ (BSD 3-Clause)
-
quart https://gitlab.com/pgjones/quart (MIT)
-
toml https://github.com/uiri/toml (MIT)
-
werkzeug https://github.com/pallets/werkzeug (BSD 3-Clause)