Installation

Important

see #Database transfer

1. Run git clone https://github.com/Stef-00012/Discord-User-Installed-Apps
2. Run npm i
3. Rename config.example.js to config.js
4. Replace the required fields in the config file
5. Run npm run db:setup in the same folder as the package.json file
6. Run npm run start in the same folder as the package.json file

Config

• token: Your Discord bot token
• owners: An array of Discord users allowed to use owner-only commands
• zipline: Configs for /upload and /shorten to work (all the values are nullable if you don't want to use zipline)
  • token: Your Zipline token
  • url: Your Zipline hostname
  • chunkSize: File chunk size, for chunked uploads (in mb)
  • maxFileSize: Max file size (in mb)
• naviac: Configs for the NAVIAC API (all the values are nullable if you don't want to use N.A.V.I.A.C. API)
  • username: Username for the API authentication
  • token: Token for the API authentication
• web: Configs for the web dashboard (all the values are nullable if you don't want to use the web dashboard)
  • enabled: Whetever the web dashboard is enabled. If enabled, [Requires MongoDB]
  • hostname: Your web dashboard hostname
  • port: Your web dashboard port
  • secure: Whetever the dashboard uses http or https
  • keepPort: whetever in the commands it should keep the port or remove it (eg. if you use a reverse proxy or port 443/80)
  • auth: Discord OAuth2 configs for the web dashboard
    • clientId: Your Discord bot client ID
    • clientSecret: Your Discord bot client secret
    • redirectURI: Your OAuth2 redirect URI
    • scopes: Your OAuth2 scopes (identify scope is required for the bot to work)
  • jwt: Config for the JSON Web Token (used to store the user ID in the browser's cookie, to keep the user logged in)
    • secret: Your JSON Web Token secret (any string, possibly hard to guess)

Database transfer

If you previously used the bot with a MongoDB database, after step 4 run npm run db:transfer in the same folder as the package.json file and skip the step 5.

Hosted

If you can not selfhost the bot, you can use the already hosted versions

• By Stef-00012 (me, /ask command avaible) - here
• By Stef-00012 (me, /aks command not avaible) - here
• By CreeperITA104 - here
• By Ninja-5000 - here

Credits

• Code: Stef-00012
• Dashboard Frontend: Ninja-5000