BNETDocs is a web content management system (CMS) and documentation software for the Battle.net™ online gaming service's protocol. It provides a means for documenting the protocol and encouraging discussion on it.
BNETDocs is in no way affiliated with or endorsed by Blizzard Entertainment™ or its brands, and is not intended to compete with or undermine Blizzard Entertainment™ or Battle.net™. Persons using this software understand that the information provided within is collected knowledge from years of observations and may be inaccurate. BNETDocs does not provide a warranty of any kind to the nature of its content. All aforementioned trademarks are the property of their respective owners. See the LICENSE file at the root of this repository for more info.
BNETDocs: Phoenix is the successor to BNETDocs: Redux.
git clone git@github.com:BNETDocs/bnetdocs-web.git ~/bnetdocs-webFollow the guide available over at carlbennett/nginx-conf.
After successfully installing carlbennett/nginx-conf, run:
sudo cp ./etc/nginx-vhost-sample.conf \
/etc/nginx/sites-available/local.bnetdocs.org.conf
sudo ln -s \
/etc/nginx/sites-available/local.bnetdocs.org.conf \
/etc/nginx/sites-enabled/After running the above, modify the new file to your liking. It's recommended
to update the server_name directives to local.bnetdocs.org. Please look
over the file and perform any updates to it as you see fit.
sudo yum install php-fpm* Use dnf instead of yum if you have it available.
sudo apt-get update && sudo apt-get install php-fpmRun composer install at the root of the repository.
sudo systemctl start nginx php-fpmsudo /etc/init.d/nginx start && sudo /etc/init.d/php-fpm startmysql < ./etc/database.sample.sqlcp ./etc/config.sample.json ./etc/config.phoenix.json* Open config.phoenix.json in your favorite text editor and modify it to
your liking.
Try accessing this endpoint: local.bnetdocs.org
* You may need to modify your /etc/hosts file if your development
environment is not your localhost.
Please read the CONTRIBUTING.md file.