How to Install
How to install Documentation System
First-time Install
- Upload the contents of the downloaded folder into the root directory of your domain. This file will include an index.php, config.php, and structure.sql file.
- Go to your webpanel (cPanel, CentOS Web Panel, or DirectAdmin) and create a new database. Make sure to keep track of the database name, database username, and user password.
- Enter into that database and insert the provided SQL file.
- Visit here and complete the following steps:
- Go back to where you uploaded the files and edit the config.php file to include the following information
- Edit the $database variable.
- Set the 'host' key to be that of your database host (in most cases, it's just 'localhost').
- Set the 'user' key to be the username of the user to access the database.
- Set the 'password' key to be the password of the user.
- Set the 'name' key to be the name of the database.
- Edit the $information variable.
- Set the 'fontAwesomeKit' key to be that of a FontAwesome kit ID (they can be created here).
- Set the 'admins' key to be an array of User IDs (this can be obtained by looking in the database for your ID after logging in with Discord or creating an account).
- Set the 'enableAccountLogin' key to be a boolean value (true or false). This enables (true) or disables (false) user account login.
- Set the 'enableDiscordLogin' key to be a boolean value (true or false). This enables (true) or disables (false) Discord login.
- Edit the $discord variable.
- Set the 'client' key to include the Discord secret from the application created in step #4.
- Set the 'secret' key to include the Discord secret from the application created in step #4.
- Set the 'botToken' key to be a bot token of a bot in your guild (the bot must have administrative privileges).
- Set the 'newUsersChannel' key to be a Discord channel ID where new users will be logged.
- Set the 'userEditsChannel' key to be a Discord channel ID where user edits will be logged.
- Go to yourdomain.tld/admin, and you'll have admin access.
First-time Install
- Upload the contents of the downloaded folder into the root directory of your domain. This file will include an index.php, resources.php, and config.php file.
- Go to your webpanel (cPanel, CentOS Web Panel, or DirectAdmin) and create a new database. Make sure to keep track of the database name, database username, and user password.
- Enter into that database and insert the provided SQL file (called structure.sql).
- Visit here and complete the following steps:
- Go back to where you uploaded the files and edit the config.php file to include the following information
- Edit the $database variable.
- Set the 'host' key to be that of your database host (in most cases, it's just 'localhost').
- Set the 'user' key to include the name of your database user.
- Set the 'password' key to include the password of your database user.
- Set the 'name' key to include the name of your database.
- Edit the $information variable:
- Set the 'fontAwesomeKit' key to a FontAwesome Kit ID. You can create a FontAwesome kit here.
- Set the 'pages' key to be the description for the home page along with the links to your website(s).
- Edit the 'discord' key:
- Set the 'guild' key to be a Discord ID for a guild in which to check for roles.
- Set the 'botToken' key to be a bot token of a bot in your guild (the bot must have administrative privileges in the guild provided).
- Set the 'client' key to include the Discord secret from the application created in step #4.
- Set the 'secret' key to include the Discord secret from the application created in step #4.
- Set the 'admins' key to be an array of Discord IDs for users you want to be administrators.
- Go to yourdomain.tld/admin, and you'll have admin access.
- You're finished!