Hawkpost
- 0 ratings
HawkPost is a web app that lets you create unique links that you can share with a person that desires to send you important information but doesn't know how to encrypt it. The message is encrypted in their browser and sent to your email address.
Deploy this app to Linode with a free $100 credit!
Hawkpost lets you create unique links that you can share with the person that desires to send you important information but doesn't know how to deal with PGP.
You can deploy your own server using the code from this repository or use the official server (that is running an exact copy of this repo) at https://hawkpost.co.
For many web and mobile development studios, no matter how hard they try to secure their client secrets (passwords, API keys, etc), the weakest link resides on the client most of the times, specially when he's not a tech savvy person. This project tries to help minimize this issue on the communication between both parties.
The way it works is like this:
In this section you can find the steps to setup a minimal development environment on your machine.
Base requirements:
On a Debian based operating system execute the following steps, after cloning the repository:
Make sure you have pipenv installed. You can check this page for more information
Install the dependencies
$ pipenv installCreate the local postgreSQL database with your user and no password
Migrate the database
$ pipenv run python manage.py migrate$ gulp build$ pipenv run python manage.py runserver
$ pipenv run celery -A hawkpost worker --beat -l infoYou can avoid pipenv run in every command if you first active the virtual environment with pipenv shell.
To use this approach you need to have Docker and Docker Compose installed. Please note that since this project uses version 2 of the Compose file format you may need to update your Docker and Docker Compose to their latest versions.
Installation instructions for every platform are available at the Docker Engine Documentation. If you use Linux you'll have to install Docker Compose manually.
After having the latest Docker and Docker Compose installed, make the folder that will hold the GPG public keys keyring:
$ mkdir -p gpg_homeSome environment variables need to be set so the application works properly.
Copy the provided .env.sample and name it .env:
$ cp .env.sample .envSince this setup assumes containers talk to each other some of the variables need to be set in order to point to the containers' names.
Edit .env and set the following variables to these values:
DB_HOST=db
DB_USER=hawkpost
DB_PASSWORD=hawkpost
REDIS_URL=redis://redis:6379/0Don't forget to set the remaining variables as well.
After setting .env correctly, just run (you may need to sudo depending
on your setup)
# Run the databases in detached mode to avoid seeing the logs
$ docker-compose up -d db redis
# Perform the migrations
# (using `--rm` to remove the temporary container afterwards)
$ docker-compose run --rm web pipenv run python manage.py migrate
# Run the web and celery containers
# (`docker-compose up` would log db and redis as well)
$ docker-compose up web celeryThese commands
db and the redis containers detached from the console, so
we're not bothered by their logs while working on the application.web container; it is removed
afterwards.web and celery attached to the
console.The web container will reload on code changes.
You may access the application by opening http://<docker-network-ip> on
your browser, which you can find by running (you may need to run this as
root depending on your setup).
CID=$(docker ps | grep 'hawkpost_web' | cut -d ' ' -f 1)
docker inspect -f "{{ .NetworkSettings.Networks.hawkpost_default.Gateway }}" $CIDThis IP won't change unless you remove every container and the corresponding
network (manually), so you may alias it on your /etc/hosts (to something like
hawkpost.test).
Note: This approach was not tested on OS X or Windows platforms, so the network feature may require additional steps.
To execute our current test suite, you just need to execute the following command after setting up your local development environment:
\$ pipenv run python manage.py test
In case you are using our docker setup the command should be:
\$ docker-compose run --rm web pipenv run python manage.py test
This project was born during an internal hackathon at Whitesmith, which is helping and supporting the current development.
Please login to review this project.
No reviews for this project yet.
Comments (0)
Please login to join the discussion on this project.