bbdoc / PoracleWeb

Web Interface add-on to PoracleJS
GNU Affero General Public License v3.0
21 stars 33 forks source link

PoracleWeb

Contributors Forks Stargazers Issues


REQUIRES MYSQL !

This tool is an add-on to PoracleJS

It requires a working webserver (typically Apache or nginx) + PHP. Alternatively it can be run out of Docker (Dockerfile is provided).


PoracleWeb handles:

Any other suggestions are welcome, please use GitHub Issues for your suggestions.


Prerequisites


Installation

  1. Clone the repo

    git clone https://github.com/bbdoc/PoracleWeb.git
  2. Install NPM packages

    npm install
  3. Copy config_example.php to config.php and adapt to your needs

  4. Have a Web Server pointing to your install directory (This tool doesn't include any standalone WebServer)

  5. You will need to configure your some basic settings in config.php:

    • Access Parameters to your Poracle DB
    • Admin ID. From discord, right click on your avatar and use "Copy ID". This defines the ID of the administrator who will be able to perform further configuration tasks.
    • Discord Bot. If you use PMSF, you can reuse the same parameters for discordBotClientId and discordBotClientSecret or find them on the Discord application Portal. redirect_url should point to your PoracleWeb base directory and should be configured as a Redirects in your Discord bot.

For those parameters go to :

  1. Go to your PoracleWeb site and head to Admin Tools / Server Settings for additional configuration steps and parameters. You need to be logged in as an admin (as defined by admin_id par ameter to be able to access this page.

Setting Up Telegram Authentication

You can enable Telegram authentication from the Server Settings page. You'll need to indicate a Bot Name for it to work.

This means you first need to [create a bot] (https://core.telegram.org/bots#3-how-do-i-create-a-bot) Once you have chosen/created a bot, send the /setdomain command to @Botfather to link your website's domain to the bot.


Contributing

  1. Fork the Project
  2. Clone your forked project
    git clone https://github.com/YourUserName/PoracleWeb.git
  3. Create your New Feature branch (git checkout -b new_feature)
  4. Create a new remote for the upstream repo with the command:
    git remote add upstream https://github.com/bbdoc/PoracleWeb
  5. Commit your Changes
    git commit -m 'Add some New Feature'
  6. Push to the Branch
    git push origin new_feature