1
0
Fork
You've already forked sciop
0
forked from Safeguarding/sciop
collecting at-risk data in torrent rss feeds
  • Python 78.4%
  • HTML 11.9%
  • CSS 7.5%
  • JavaScript 1.8%
  • Jinja 0.3%
2025年05月27日 20:59:16 +02:00
.forgejo get_config and autoloading 2025年05月22日 01:23:55 -07:00
docs changelog 2025年05月26日 16:56:04 -07:00
scripts fix datetime handling when last seen at is present, make utcdatetime type 2025年03月19日 02:46:59 -07:00
src/sciop whoops, re-add commented code 2025年05月26日 16:40:04 -07:00
tests tests for random quotes 2025年05月23日 21:25:04 -07:00
.env.sample config cli 2025年04月30日 19:09:00 -07:00
.gitignore get_config and autoloading 2025年05月22日 01:23:55 -07:00
changelog.md refactor config into sub-models 2025年05月21日 22:15:05 -07:00
LICENSE Initial commit 2025年02月02日 01:27:17 +00:00
mkdocs.yml made icon link to site root 2025年05月27日 14:41:03 -04:00
pdm.lock quickstart 2025年05月12日 22:27:40 -07:00
pyproject.toml get_config and autoloading 2025年05月22日 01:23:55 -07:00
README.md config cli 2025年04月30日 19:09:00 -07:00
sciop.sample.yaml complete sentence 2025年04月30日 19:09:04 -07:00

SciOp

[ docs ] [ source ]

As a website and group of people: A distributed archive curated by distributed archivists preserving public information to plug the memoryhole.

As software: An experimental (soon to be) federated bittorrent tracker.

Running a SciOp Instance

Please see full instructions in the contributing docs

Installing

Clone the repository:

git clone https://codeberg.org/Safeguarding/sciop
cd sciop

With pip

Make a python virtual environment and activate it:

python -m venv ~/.envs/sciop
. ~/.envs/sciop/bin/activate

Install dependencies and then sciop itself in-place as an editable requirement:

pip install -e .

sciop is also available on PyPI, though while we are in beta we do not regularly deploy versions there, so installing from the repository is strongly recommended.

python -m pip install sciop

With PDM

Install dependencies, automatically creating a virtual environment by default

pdm install

Configuration

All of the following commands can be run either with a venv or pdm install, though only the venv version is shown. For PDM installs, just prepend pdm run like pdm run sciop start

Create a default configuration:

# to see all config commands,
# sciop config --help
sciop config copy

Two fields must be set:

  • SCIOP_ENV/env: one of dev, test or prod. One should only make a sciop instance publicly available in prod mode. dev mode is for local development purposes, as is test. You must ensure that you do not re-use the same db between a dev/test and prod instance, e.g. if the SCIOP_DB location is explicitly set to something other than the defaults.
  • SCIOP_SECRET_KEY/secret_key: must be a securely-generated random hex value. A key can be generated with openssl rand -hex 32.

When generated from the cli, env is set to dev, and secret_key is automatically generated.

Run the dev sever

# see available CLI commands
# sciop --help
sciop start

License

EUPL v1.2

Vendored Software

This project includes the following vendored software: