Parrot

Parrot is a self-hosted Localization Management Platform, this document describes how to deploy it and how to interact with the API layer.

Installation / Deployment

NOTICE: the project is still in heavy development and it is NOT recommended for use in production until a version 1.0 is reached.

The easiest way to get started is using docker and docker-compose. Simply clone this repo, navigate to the root of it and start the services:

$ git clone https://github.com/anthonynsimon/parrot.git
$ cd parrot
$ sudo /bin/bash scripts/buildweb.sh
$ sudo /bin/bash scripts/start.sh

Please note that to build the web app, npm is required.

This will build the web app and launch 3 containers: a Postgres database, the Parrot API server and Nginx as the reverse proxy and static file server.

Navigate to https://localhost/api/v1/ping and you should be able to see if the API is up (your browser will complain about an unknown certificate, see the HTTPS notice below for more info).

And to view the web app simply navigate to https://localhost, it should open the login page of the web app.

Important note on HTTPS

For convinience, self-signed SSL certificates are provided for the reverse-proxy (nginx). Do NOT use them for anything other than development, use your own certificates instead. We recommended automating the generation and renewal of the certificates via Let's Encrypt. The /etc/nginx/certs and /etc/nginx/vhost.d volumes on the nginx container has been made available for this purpose.

results matching ""

    No results matching ""