Inviting the Bot
Use the hosted bot or self-host the Endvoyant source code yourself
Hosted Bot
The hosted version is the recommended path if you want the fastest setup.
First Steps After Inviting
- Run
/aboutto confirm the bot is installed where you expect it. - Run
/add accountand choose either the login flow or the cookie/token fallback flow. - Open
/settingsto set your privacy, language, and DM notification preferences. - Use
/attendance,/profile, or/eventsto verify your setup.
Self-Hosting
If you want your own deployment, the current source expects:
- Node.js
- PostgreSQL
- A Discord application with a bot token, client ID, and client secret
Environment Variables
Copy example.env to .env and set:
| Variable | Required | Purpose |
|---|---|---|
TOKEN | Yes | Discord bot token |
CLIENT_ID | Yes | Discord application client ID |
CLIENT_SECRET | Yes | Discord application client secret |
DATABASE_URL | Yes | PostgreSQL connection string |
ENVIRONMENT | Yes | development or production |
SURVEY_WEBHOOK | Optional | Destination for /survey submissions |
Setup Flow
If you want your own deployment:
- Clone the repository.
- Install dependencies with
npm install. - Copy
example.envto.envand fill in the required values. - Run
npm run db:migrate. - Deploy slash commands with
npm run deploy. - Start the bot with
npm start.
Requirements
- Node.js
- PostgreSQL
- A Discord application with bot credentials
Runtime Behavior
When the bot is online, the current source also starts background jobs for:
- rotating the Discord presence on a schedule
- automatic attendance for accounts with auto check-in enabled
- refreshing linked account tokens in the background
Those jobs use the same linked-account and user settings managed through /settings.
For the full project source, see the GitHub repository.
Last updated on