<commit_before>VagrIRC
=======
IRC Testnet provisioning made easy, with Vagrant!

Basically, this is designed to make my IRC development network provisioning more simple and easy.

**DO NOT USE THIS FOR A PRODUCTION NETWORK. IT IS TERRIBLE FOR THAT AND HAS HOLES AND IS IN NO WAY TESTED FOR SECURITY**


Installation
------------
You need to make sure `Python3 <https://www.python.org/downloads/>`_ and `Vagrant <https://www.vagrantup.com/>`_ are installed on your machine to use this tool. Unixy OSes are recommended as no testing has been performed with Windows (though hopefully it should work).

1. ``git clone https://github.com/DanielOaks/vagrirc.git``
2. ``cd vagrirc``
3. ``vagrant plugin install vagrant-cachier``
4. ``pip3 install -r requirements.txt``
5. ``./vagrirc.py generate --oper coolguy:coolpassword --ircd hybrid --services anope2``
6. ``./vagrirc.py write``
7. ``vagrant up``

Step three is optional, but recommended as it means all sorts of packages will get cached between installs, which saves lots of time when provisioning a new machine.

Vagrant will run through the setup of your machine, including compiling the ircd / services / etc, registering your given nick/password via nickserv, and setting you up as an ircd and services oper.

Everything is laid out in the ``irc/`` folder. Underneath there, the ``bin`` folder is where your running services and programs run - and where you can change the configuration files for each program. Keep in mind that simply running ``./vagrirc write`` should not overwrite the contents of that ``bin`` folder, as it is populated during provisioning.


FAQ
---<commit_msg>readme: Specify overwriting better<commit_after>VagrIRC
=======
IRC Testnet provisioning made easy, with Vagrant!

Basically, this is designed to make my IRC development network provisioning more simple and easy.

**DO NOT USE THIS FOR A PRODUCTION NETWORK. IT IS TERRIBLE FOR THAT AND HAS HOLES AND IS IN NO WAY TESTED FOR SECURITY**


Installation
------------
You need to make sure `Python3 <https://www.python.org/downloads/>`_ and `Vagrant <https://www.vagrantup.com/>`_ are installed on your machine to use this tool. Unixy OSes are recommended as no testing has been performed with Windows (though hopefully it should work).

1. ``git clone https://github.com/DanielOaks/vagrirc.git``
2. ``cd vagrirc``
3. ``vagrant plugin install vagrant-cachier``
4. ``pip3 install -r requirements.txt``
5. ``./vagrirc.py generate --oper coolguy:coolpassword --ircd hybrid --services anope2``
6. ``./vagrirc.py write``
7. ``vagrant up``

Step three is optional, but recommended as it means all sorts of packages will get cached between installs, which saves lots of time when provisioning a new machine.

Vagrant will run through the setup of your machine, including compiling the ircd / services / etc, registering your given nick/password via nickserv, and setting you up as an ircd and services oper.

Everything is laid out in the ``irc/`` folder. Underneath there, the ``bin`` folder is where your running services and programs run - and where you can change the configuration files for each program. Keep in mind that simply running ``./vagrirc write`` should not overwrite the contents of that ``bin`` folder, as it is populated during provisioning.

**NOTE:** ``/irc/build/*`` scripts **WILL OVERWRITE YOUR PROJECT'S ``/irc/bin/etc`` FOLDER**. For service bots like ``acid``, running the automatic build script will overwrite any changes you've made and your git repo in there.


FAQ
---
{'fraction_non_alphanumeric': 0.09591373439273553, 'fraction_numerical': 0.0056753688989784334, 'mean_word_length': 4.214497041420119, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 6, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3562977', 'n_tokens_mistral': 1008, 'n_tokens_neox': 966, 'n_words': 496}