Skip to content

fugacious/fugacious

Repository files navigation

SemVer CircleCI Dependency Status security Test Coverage

Fugacious

open source short-term secure messaging solution

 


How it works

Need to send a secret to someone? Use Fugacious to ensure that no permanent record of your secret will remain.

  1. Visit fugacio.us
  2. Enter your secret
  3. Share your link

The link to your secret will only remain alive for the preset amount of time or number of views.

Getting started with development

Dependencies

Be sure Docker is running, then

  1. Build the environment with:
$ docker-compose build
  1. Start the server
$ docker-compose up

That's it, the app is running on http://localhost:3000

Local setup

  1. Setup application dependencies
$ bin/setup
  1. Start the app
$ foreman start -p 3000
  1. Open your browser to http://localhost:3000

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -m 'Adds some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

See CONTRIBUTING.md for more information

Deploying to Heroku

Use this friendly button:

Deploy

Or, use our friendly bootstrap script:

Ensure you have the Heroku Toolbelt installed.

  1. Execute Heroku setup with bin/heroku. Your shell output should look something like this and once successfully launched, will open your new Fugacious instance!

Getting started with Rails 4 on Heroku for more information.

Deploying to cloud.gov

  1. Configure cloud.gov specific settings in config/secrets.yml
  2. Run bin/push_cloud_dot_gov

Operators

Fugacious URLs should be treated as sensitive information since knowing the URL could allow someone to access the stored secret (assuming it was accessed within the time-to-live of the secret). This means you should be careful about how you configure your HTTP server. Many have a default configuration to log all requests, including these sensitive URLs, to file or to stdout. Most PaaS, like Heroku or Cloud Foundry are configured this way, too.

Operators of fugacious should take this into consideration when setting up their app. Otherwise, they will potentially be disclosing sensitive information to their hosting providers.

License

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

For more information, see license.