- Give Josh an ssh public key to authorize access to dokku.
- git clone this repo
git remote add dokku dokku@flushlyft.com:harry-tuttle
git push dokku
Generally that's all you'll need to do.
It will take several minutes
and you'll see a bunch of status messages
that are included as the output of your git push command.
If there are errors, they're usually pretty helpful.
If you get into an egregiously bad state and it's refusing to deploy,
you can kick it with ssh dokku@flushlyft.com apps:unlock harry-tuttle.
(But you should need this rarely, if ever.)
- To view recent logs:
ssh dokku@flushlyft.com logs harry-tuttle - To continuously follow the logs:
ssh dokku@flushlyft.com logs harry-tuttle -t
You'll probably never need to do this, but:
ssh dokku@flushlyft.com config:set harry-tuttle VAR=val
This will be available in the code as an environment variable (e.g. process.env.VAR).
To start the bot, in the command prompt, run the following command:
node index.js
You shouldn't need anything beyond this point in order to do routine development and maintenance, but it's preserved in case it matters later
gitcommand line (Windows|Linux|MacOS) installednodeVersion 12.0.0 or higher- The node-gyp build tools. This is a pre-requisite for Enmap, but also for a lot of other modules. See The Enmap Guide for details and requirements for your OS. Just follow what's in the tabbed block only, then come back here!
You also need your bot's token. This is obtained by creating an application in the Developer section of discord.com. Check the first section of this page for more info.
Guidebot uses intents which are required as of October 7, 2020.
You can enable privileged intents in your bot page
(the one you got your token from) under Privileged Gateway Intents.
By default GuideBot needs the Guilds, Guild Messages and Direct Messages intents to work. For join messages to work you need Guild Members, which is privileged. User counts that GuideBot has in places such as in the ready log, and the stats command may be incorrect without the Guild Members intent.
Intents are loaded from your config, and will get created by the setup scripts.
For more info about intents checkout the official Discord.js guide page and the official Discord docs page.
To add the bot to your guild, you have to get an oauth link for it.
You can use this site to help you generate a full OAuth Link, which includes a calculator for the permissions: https://finitereality.github.io/permissions-calculator/?v=0
This bot is based on the example Discord.js Bot Handler updated and Maintained by the Idiot's Guide Community.