The SCUTTLE Translator Directory System

Named after RAISA's famous cautionary tale, SCUTTLE provides a user friendly way for tracking our members' contributions to the translation project.

Details on the scoring system can be found on our Discord.

Features

• Stores translation metadata (name, translator, wiki page, word count and bonus translator points)
• Stores user info (nickname, Wikidot ID, Discord username)
• Automatically fetches nicknames and profile avatars from Discord
• Login using classic credentials or Discord OAuth
• Fully Dockerized

Planned features

• Fetching new pages from RSS feeds
• Note system for moderators
• A statistics page
• Automatic word counting (hard >w<)
• Improve responsivity on mobile and smaller windows

Installation (manual)

1. Clone the repository

git clone https://github.com/scp-cs/translatordb_web.git
cd translatordb_web

2. Create a config file

config.json

{
    "DEBUG": false,
    "SECRET_KEY": "[SECRET KEY USED BY FLASK]",
    "DISCORD_TOKEN": "[YOUR DISCORD APP TOKEN]"
    "DISCORD_CLIENT_SECRET": "[YOUR DISCORD OAUTH SECRET]",
    "DISCORD_CLIENT_ID": [YOUR DISCORD APP ID],
    "DISCORD_REDIRECT_URI": "https://your-app-url.xyz/oauth/callback",
    "DISCORD_WEBHOOK_URL": [A WEBHOOK TO YOUR ADMIN/LOG CHANNEL],
    "DISCORD_ROLEMASTER_ID": [DISCORD ID OF THE PERSON RESPONSIBLE FOR ROLES],
    "RSS_MONITOR_CHANNELS": [
        "http://your-wiki.wikidot.com/feed/site-changes.xml",
        "http://your-wanderers-library.wikidot.com/feed/site-changes.xml",
        "http://your-backrooms-or-whatever.wikidot.com/feed/site-changes.xml"
    ]
}

DISCORD_TOKEN, DISCORD_CLIENT_ID and DISCORD_CLIENT_SECRET can be found on your Discord Developer Portal.

Note

Keep in mind that your redirect URI must exactly match one of the URIs entered on the developer portal, even when testing locally. Login attempts will fail otherwise.

DISCORD_WEBHOOK_URL - A webhook that will be used to send notifications and alerts, you can generate one in your server settings.

DISCORD_ROLEMASTER_ID - User ID of the moderator responsible for roles.

RSS_MONITOR_CHANNELS - An RSS feed URL for each one of your sites.

SECRET_KEY should be a reasonably long random string and never shared with anyone. You can generate one, for example, using the Python secrets library:

import secrets
print(secrets.token_urlsafe(24))

3. Define the initial admin user

export SCP_INIT_USER=administrator
export SCP_INIT_PASSWORD=password

4. Run the app

python App.py

Installation (Docker)

SCUTTLE is available as a prebuilt container image on DockerHub

Warning

If you're running SCUTTLE behind a reverse proxy and communicating over HTTP internally, the environment variable OAUTHLIB_INSECURE_TRANSPORT has to be set, any requests to the app will fail otherwise.

docker run -d -p 8080:8080 -v /your/log/path:/app/translatordb.log -v /your/data/path:/app/data/scp.db -v /your/config/path:/app/config.json:ro --name scuttle x10102/translatordb