Installing Cyphon¶
Docker¶
Cyphon is most easily installed using Docker. We maintain a collection of Docker Compose files for this purpose. See our Cyphondock documentation for instructions on this kind of deployment.
Installer ISO¶
If you’d like a quick way to try out Cyphon, you can download our Cyphon installer ISO, which creates a Cyphondock deployment on an Ubuntu Server 16.04.3 LTS.
Manual Install¶
Services¶
If you prefer to manually install Cyphon, you’ll need to have running instances of the following services:
- PostgreSQL/PostGIS
- RabbitMQ
- Logstash
- Elasticsearch and/or MongoDB
- Nginx or Apache
Cyphon¶
Clone the project from GitHub:
$ git clone https://github.com/dunbarcyber/cyphon.git
Use the example files in ./cyphon/cyphon/settings to create your own conf.py, base.py, dev.py, and prod.py files.
Dependencies¶
Cyphon is compatible with Python 3.4 or higher. To install Cyphon’s required Python packages, run the setup script:
$ python3 setup.py install
GeoLite2 City Database¶
Cyphon’s GeoIP package requires the GeoLite2 City database. Download this database and update the GEOIP setting in ./cyphon/cyphon/settings/conf.py with the path to the database.