Skip to content

Latest commit

 

History

History
250 lines (150 loc) · 11.2 KB

README.md

File metadata and controls

250 lines (150 loc) · 11.2 KB
Raw

Password Pusher Front Page

Simple & Secure Password Sharing with Auto-Expiration of Shared Items

Github CI Dependencies Status Semantic Versions License

Password Pusher is an opensource application to communicate passwords over the web. Links to passwords expire after a certain number of views and/or time has passed.

Hosted at pwpush.com but you can also easily run your own private instance with just a few steps.

  • Easy-to-install: Host your own via Docker, a cloud service or just use pwpush.com
  • Opensource: No blackbox code. Only trusted, tested and reviewed opensource code.
  • Audit logging: Track and control what you've shared and see who has viewed it.
  • Encrypted storage: All sensitive data is stored encrypted and is deleted once expired.
  • Host your own: Database backed or ephemeral, easily run your own instance isolated from the world.
  • JSON API: Raw JSON API available for 3rd party tools or command line via curl or wget.
  • Command line interface: Automate your password distribution with CLI tools or custom scripts.
  • Internationalized: 14 language translations are bundled in. Easily selectable via UI or URL
  • Unbranded delivery page: No logos, superfluous text or unrelated links to confuse end users.
  • Customizable: Change text and default options via environment variables.
  • Light & dark themes: Via CSS @media integration, the site theme follows your local preferences
  • 10 Years Old: Password Pusher has securely delivered millions and millions of passwords in it's 10 year history.
  • Honest Software: Opensource written and maintained by me with the help of some great contributors. No organizations, corporations or evil agendas.

Follow Password Pusher on Twitter, Gettr or on Facebook for the latest news, updates and changes.

Quickstart

→ Go to pwpush.com and try it out.

or

→ Run your own instance with one command: docker run -d -p "5100:5100" pglombardo/pwpush-ephemeral:release then go to http://localhost:5100

or

→ Use one of the 3rd party tools that interface with Password Pusher.

💾 Run Your Own Instance

Note: Password Pusher can be largely configured by environment variables so after you pick your deployment method below, make sure to read the configuration page. Take particular attention in setting your own custom encryption key which isn't required but provides the best security for your instance.

On Docker

Docker images of Password Pusher are available on Docker hub.

➜ ephemeral Temporary database that is wiped on container restart.

docker run -d -p "5100:5100" pglombardo/pwpush-ephemeral:release

Learn more

➜ using an External Postgres Database Postgres database backed instance.

docker run -d -p "5100:5100" pglombardo/pwpush-postgres:release

Learn more

➜ using an External MariaDB (MySQL) Database Mariadb database backed instance.

docker run -d -p "5100:5100" pglombardo/pwpush-mysql:release

Learn more

Note: The latest Docker container tag builds nightly off of the latest code changes and can occasionally be unstable. Always use the 'release' or version'd tags if you prefer more stability in releases.

With Docker Compose

➜ One-liner Password Pusher with a Postgres Database

curl -s -o docker-compose.yml https://raw.githubusercontent.com/pglombardo/PasswordPusher/master/containers/docker/pwpush-postgres/docker-compose.yaml && docker compose up -d

➜ One-liner Password Pusher with a MariaDB (MySQL) Database

curl -s -o docker-compose.yml https://raw.githubusercontent.com/pglombardo/PasswordPusher/master/containers/docker/pwpush-mysql/docker-compose.yaml && docker compose up -d

On Kubernetes

Instructions and explanation of a Kubernetes setup can be found here.

On Microsoft Azure

There used to be a 3rd party blog post with instructions but it's been deleted. If anyone has instructions they would like to contribute, it would be greatly appreciated.

See issue #277

On OpenShift

See our OpenShift documentation.

On Heroku

One click deploy to Heroku Cloud without having to set up servers.

Deploy

This option will deploy a production Password Pusher instance backed by a postgres database to Heroku. As is monthly cost: $0.

From Source

Make sure you have git and Ruby installed and then:

git clone [email protected]:pglombardo/PasswordPusher.git
cd PasswordPusher
gem install bundler
bundle install --without development production test --deployment
bundle exec rake assets:precompile
RAILS_ENV=private ./bin/rake db:setup
./bin/rails server --environment=private

Then view the site @ http://localhost:5100/.

3rd Party Tools

Command Line Utilities

Libraries & APIs

  • oyale/PwPush-PHP: a PHP library wrapper to easily push passwords to any Password Pusher instance

Android Apps

Application Integrations

The Password Pusher API

Internationalization

Password Pusher is currently available in 14 languages with more languages being added often as volunteers apply.

From within the application, the language is selectable from a language menu. Out of the box and before any language menu selection is done, the default language for the application is English.

Changing the Default Language

The default language can be changed by setting an environment variable with the appropriate language code:

PWP__DEFAULT_LOCALE=es

For more details, a list of supported language codes and further explanation, see the bottom of this configuration file.

📼 Credits

Translators

Thanks to our great translators!

If you would like to volunteer and assist in translating, see this page.

Also thanks to translation.io for their great service in managing translations. It's also generously free for opensource projects.

Containers

Thanks to:

Other

Thanks to:

...and many more. See the Contributors page for more details.