Installation

1. Run git clone https://github.com/Stef-00012/userApps.
2. Open the folder, cd userApps.
3. rename .env.example to .env and fill the environment variables (See #Config)
4. run npm run db:setup
5. Run docker compose up -d.

Config

• BOT_TOKEN: Your Discord bot token.

• OWNERS: An list of Discord users allowed to use owner-only commands (split by ,). Example: 123,456,789.

• PUBLIC: Whether the bot is public, if so, when the web is enabled, a /invite route is created that redirects to the bot's invite.

• AUTO_UPDATE_AVATAR: An user ID or a boolean (when true, it defaults to the first owner ID).

• ZIPLINE_TOKEN: Your Zipline token. ¹

• ZIPLINE_URL: Your Zipline hostname. ¹

• ZIPLINE_CHUNK_SIZE: File chunk size, for chunked uploads (in mb). ¹

• ZIPLINE_MAX_FILE_SIZE: Max file size (in mb). ¹

• ZIPLINE_VERSION: Your Zipline Version. ¹

• NAVIAC_USERNAME: Username for the N.A.V.I.A.C. API authentication. ²

• NAVIAC_TOKEN: Token for the N.A.V.I.A.C. API authentication. ²

• DASHBOARD_ENABLED: Whether the web dashboard is enabled.

• DASHBOARD_HOSTNAME: Your web dashboard hostname.

• DASHBOARD_SECURE: Whether the dashboard uses http or https.

• DASHBOARD_URL_KEEP_PORT: Whether in the commands it should keep the port or remove it (eg. if you use a reverse proxy or port 443/80).

• DISCORD_CLIENT_ID: Your Discord bot client ID.

• DISCORD_CLIENT_SECRET: Your Discord bot client secret.

• DISCORD_REDIRECT_URI: Your OAuth2 redirect URI. Should end with /login.

• JWT_SECRET: Your JSON Web Token secret (any string, possibly hard to guess).

• DISCORD_WEBHOOK_ENABLED: Whether you want to use discord webhook events (currently only application authorized event is supported), required web dashboard. When enabled it starts listening on /discord/webhook.

• DISCORD_WEBHOOK_PUBLIC_KEY: The public key from you developer portal application.

• DISCORD_WEBHOOK_NOTIFICATION_URLS: Urls where to send the notifications when an event is triggered (split by ,). Must be an AppRise Compatible URL.

• DISCORD_WEBHOOK_MESSAGE_TITLE: Notification title when someone authorizes your bot. ³

• DISCORD_WEBHOOK_MESSAGE_BODY: Notification body when someone authorizes your bot. ³

Hosted

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

• By Stef-00012 (me) - here.
• By CreeperITA104 - here.
• By Ninja-5000 - here.
• By Satindar - here.

Credits

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

Footnotes

1. Zipline is https://zipline.diced.sh. ↩ ↩² ↩³ ↩⁴ ↩⁵

2. N.A.V.I.A.C. is an AI. ↩ ↩²

3. Message title and body support those templates:
   - {{user}}: Username of the user who authorized.
   - {{user.id}}: ID of the user who authorized.
   - {{bot}}: Bot username.
   - {{time}}: Day and hour when the event happened. ↩ ↩²