Miner Club is a ready made web app built to help people run Minecraft servers with access limited to those within the 'club' and a limited number of guests.

Users first activate their accounts, verifying their identity by providing an access code.

After this, an email is sent to them with a unique link that allows them and a defined quota of users to add their names to the whitelist.

The list of registered Minecraft usernames Miner Club generates a whitelist automatically and then syncs this whitelist with a remove server over SFTP, FTPS or FTP.

1. Clone (or download and unzip) this repo! git clone https://github.com/0Hughman0/MinerClub
2. Navigate into the directory with Pipfile in it.
3. Install the dependencies (requires pipenv!) via pipenv install
4. MinerClub now uses .env for configuration. To configure, make a file named .env in that directory, putting PARAMETER=value on each line.
5. Configure your app by setting the following environment variables:

5. Next you need to configure the way MinerClub writes the updated whitelist to your server. To do this you need to set the FILE_ENGINE variable. How you do this depends on where you have your Minecraft Server running. Your current options are:

5. Each FILE_ENGINE has its own configuration options:

• SFTP

• FTP:

• FTPS (Note to use this method you need to generate a public and private keypair server-side, and install the public key onto the machine running MinerClub):

• LOCAL:

5. Navigate to the members.csv file and replace the examples with the 'Membership IDs' of your members (one per line), or set USE_MEMBERS_LIST=False in your config to allow anyone with the access code to join. If True, when users activate their accounts, the name they provide must be in this file. In most cases I'd expect this to be a list of emails (meaning that EMAIL_TEMPLATE={}).
6. Make any changes you want to the template files, in particular the email templates and the privacy policy template. Note that because these Jinja2 templates are rendered by the flask application, you can access the app.config object and the member or whitelist object.
7. Set the environment variable FLASK_APP=app
8. Initialise the database by entering pipenv run flask minerclub init
9. Run the server using your preferred method. Note that I thoroughly recommend using https in order to ensure security.
10. Set your Minecraft server to refresh the whitelist regularly. You can do this with a Cron job.

The app provides the following additional commands (ran with pipenv run flask minerclub command-name):

• reset-db - This completely clears the database.
• force-sync - This forces the app to sync the current whitelist version with the server (useful if making manual changes)
• backup --cycle or backup --no-cycle - This creates a local copy of server directories from your config (defaults to 'world', 'world_nether' and 'world_the_end').

For slightly more info, run pipenv run flask minerclub --help.

To assist with any manual changes, the app provides both the (get shell) gs.bat and gs.sh scripts. Once in a shell you can use (shell tools) from st import * to import a few helper functions/ variables.

Don't run this server if you don't know what you're doing, you are storing peoples emails, so this needs to be done securely.

Although I use the word 'sync', the app actually just completely overwrites the old whitelist.json file, so be careful about data-loss.

Whilst the app is able to keep the whitelist.json file up to date, your Minecraft server instance still needs to reload the whitelist for these changes to take effect. Most server hosts provide a tasks feature that can be used to automatically run a whitelist reload command. (You might also be able to achieve this through plugins).

Once everything is set up you can run the set of integration tests using pipenv run pytest to check everything is working fine (they take a little while!).

If you are having trouble with installation of dependencies like bcrypt and cryptography, make sure you are using the latest version of pip (this caused me an immense deal of frustration recently!)