https://github.com/victims/victims-api
Future victi.ms microservice
https://github.com/victims/victims-api
api java microservice python rest-api ruby scanner security victims
Last synced: 3 months ago
JSON representation
Future victi.ms microservice
- Host: GitHub
- URL: https://github.com/victims/victims-api
- Owner: victims
- License: agpl-3.0
- Created: 2015-08-16T19:47:00.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-09T23:44:42.000Z (over 8 years ago)
- Last Synced: 2025-02-06T05:29:47.325Z (about 1 year ago)
- Topics: api, java, microservice, python, rest-api, ruby, scanner, security, victims
- Language: Go
- Size: 31.3 KB
- Stars: 0
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
victims-api
===========
[](https://travis-ci.org/victims/victims-api/)
Public API to the victims data set.
Building
========
For all targets run ``make help``
Dynamic
-------
1. Install dependencies via ``govendor`` by running: ``make deps``
2. Run ``make victims-api``
3. Execute ``./victims-api run``
Static
------
1. Install dependencies via ``govendor`` by running: ``make deps``
2. Run ``make static-victims-api``
3. Execute ``./victims-api run``
Image
-----
1. Run ``make image``
Running
=======
Manually
--------
To find out the available flags run:
```
$ victims-api run --help
```
Example:
```
$ victims-api run \
--mongodb-database victims \
--mongodb-host 127.0.0.1 \
--mongodb-user myuser \ # Optional
--mongodb-password secret # Optional
```
Environment
-----------
**TODO**: Update environment vars to either use a URI OR add a ``MONGODB_HOST`` environment variable.
Set the following environment variables:
- ``MONGODB_USER``: User to connect to the databse with
- ``MONGODB_PASSWORD``: Password to connect to the database with
- ``MONGODB_DATABASE``: Databse to use (usually ``victims``)
```
$ ./victims-api --mongodb-host 127.0.0.1 --mongodb-use-env
```