Giter Club home page Giter Club logo

sneedznab's Introduction

Sneedznab

Running with Docker

Keys to collect note there is no API key for the indexer itself, as this project is intended to run on an internal Docker network, without ports being expoesd to the internet

  • AnimeBytes - for AnimeBytes results // only required if you are using AnimeBytes
  • If you are using Redis as your cache, you can retrieve the REDIS_URL and REDIS_TOKEN keys from Upstash

Clone the repository or fetch it however you want:

git clone https://github.com/TurboCheetah/sneedznab.git
cd sneedznab

Edit the environment variables in docker-compose.yml to suit your needs.

Finally, spin up a Docker container using docker-compose up -d.

Explaination of environment variables

  • <PROVIDER>_ENABLED: when set to true Sneedznab will search this provider for the requested anime
  • ANIMEBYTES_PASSKEY: your AnimeBytes passkey. Only required if ANIMEBYTES_ENABLED is set to true. See above for where to obtain it
  • ANIMEBYTES_USERNAME: your AnimeBytes usersname. Only required if ANIMEBYTES_ENABLED is set to true. This is required for interacting with their API
  • REDIS_ENABLED: determines whether or not to use Redis as the cache provider instead of a local in-memory cache
  • REDIS_URL: the URL to the Redis database hosted by Upstash. Only required if REDIS_ENABLED is set to true. See above for where to obtain it
  • REDIS_TOKEN: the token used to access the Redis database. Only required if REDIS_ENABLED is set to true
  • CACHE_TTL: how long a cached entry should live in the cache for
  • DEBUG: toggles verbose logging

Segmentation Faults

Due to its instability, Bun may segfault after performing a search. From my testing this only has a chance of occuring on the first search. If you encounter this, just restart the container and perform a test search until it doesn't segfault.

sneedznab's People

Contributors

renovate[bot] avatar turbocheetah avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.