Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Community ProtonDB API

This simple application takes the ProtonDB database dumps from the ProtonDB project, stores it in a real database and serves a simple API to query it.

Installing

These instructions haven't really been tested and only serve as a general guidance on how to set up the PHP application. This assumes you already have an nginx, PHP and MySQL setup going.

  1. Configure the MySQL database
    1. Import the contents of /contrib/initdb.sql to your database
    2. Copy /contrib/config.php to /config.php
    3. Edit /config.php and input your MySQL credentials
  2. Configure nginx to add the server defined in /contrib/nginx.conf.
  3. (optional) Set up the protobdb-data repository
    1. Clone the protondb-data repository to /data.git
    2. Copy /contrib/post-merge.sh to /data.git/.git/hooks/ to automatically import new data whenever the git repository is updated
    3. Add a cronjob or systemd timer to git pull the repository

About

An unofficial API for the ProtonDB database dumps

Resources

License

Releases

No releases published
You can’t perform that action at this time.