passman/README.md

#Currently in BETA
#Passman

[![Build Status](https://travis-ci.org/nextcloud/passman.svg?branch=master)](https://travis-ci.org/nextcloud/passman)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/passman/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/passman/?branch=master)
[![Code Coverage](https://scrutinizer-ci.com/g/nextcloud/passman/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/passman/?branch=master)


Passman is a full featured password manager.
Features:
- Vaults
- Vault key is never sent to the server
- Credentials are stored with 256 bit AES
- Ability to add custom fields to credentials
- Built-in OTP(One Time Password) generator
- Password analyzer
- Share passwords internally and via link in a secure manner.
- Import from various password managers:
  - KeePass
  - LastPass
  - DashLane
  - ZOHO
  - Clipperz.is


## Tested on
- NextCloud 10+
- ownCloud 9.1+


## Supported databases
- SQL Lite*
- MySQL / MariaDB*

*Tested on travis

Untested databases:
- pgsql


##Screenshots
![Logged in to vault](http://i.imgur.com/ciShQZg.png)   

![Credential selected](http://i.imgur.com/3tENldT.png)   

![Edit credential](http://i.imgur.com/Iwm3hUe.png)   

![Password tool](http://i.imgur.com/ZYkN70r.png)

For more screenshots: [Click here](http://imgur.com/a/giKVt)

## Code reviews
If you have any improvements regarding our code.
Please do the following
- Clone us
- Make your edits
- Add your name to the contributors 
- Send a PR   

Or if you're feeling lazy, create an issue, and we'll think about it.

## Docker
To run passman with docker you can use `docker run  -p 8080:80 -p 8443:443 brantje/passman`
To use your own SSL cert mount them as below   
Example:   
`docker run -p 8080:80 -p 8443:443 -v /directory/cert.pem:/data/ssl/cert.pem -v /directory/cert.key:/data/ssl/cert.key brantje/passman`


## Development
Passman uses a single `.js` file for the templates. This gives the benefit that we don't need to request every template with XHR.   
For CSS we use SASS so you need ruby and sass installed.  
`templates.js` and the CSS are build width `grunt`.
To watch for changes use `grunt watch`
To run the unit tests install phpunit globally, and stup the envioronment variables on the `launch_phpunit.sh` script then just run that script any argumetns passed to this script will be forwarded to phpunit.

## Main developers
- Brantje
- Animalillo

## Contributors
Add yours when creating a pull request!
- None


## FAQ
**Are you adding something to check if malicious code is executing on the browser?**   
No, because malitous code could edit the functions that check for malicious code.
update readme 2016-10-08 02:31:07 +08:00			`#Currently in BETA`
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`#Passman`
Update readme 2016-10-08 04:08:00 +08:00
Update readme 2016-10-08 06:41:35 +08:00			`[![Build Status](https://travis-ci.org/nextcloud/passman.svg?branch=master)](https://travis-ci.org/nextcloud/passman)`
			`[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/passman/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/passman/?branch=master)`
			`[![Code Coverage](https://scrutinizer-ci.com/g/nextcloud/passman/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/passman/?branch=master)`

Update readme 2016-10-08 04:08:00 +08:00
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`Passman is a full featured password manager.`
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`Features:`
			`- Vaults`
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`- Vault key is never sent to the server`
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`- Credentials are stored with 256 bit AES`
			`- Ability to add custom fields to credentials`
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`- Built-in OTP(One Time Password) generator`
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`- Password analyzer`
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`- Share passwords internally and via link in a secure manner.`
Update readme 2016-10-13 04:24:08 +08:00			`- Import from various password managers:`
			`- KeePass`
			`- LastPass`
			`- DashLane`
			`- ZOHO`
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`- Clipperz.is`

Update readme 2016-10-13 05:06:11 +08:00
Update readme 2016-10-10 00:35:34 +08:00			`## Tested on`
			`- NextCloud 10+`
			`- ownCloud 9.1+`


Update readme 2016-10-14 21:49:08 +08:00			`## Supported databases`
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`- SQL Lite*`
			`- MySQL / MariaDB*`
Update readme 2016-10-14 21:49:08 +08:00
			`*Tested on travis`

Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			`Untested databases:`
Update readme 2016-10-14 21:49:08 +08:00			`- pgsql`


Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`##Screenshots`
			`![Logged in to vault](http://i.imgur.com/ciShQZg.png)`
Initial commit 2016-09-09 23:36:35 +08:00
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`![Credential selected](http://i.imgur.com/3tENldT.png)`
Initial commit 2016-09-09 23:36:35 +08:00
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`![Edit credential](http://i.imgur.com/Iwm3hUe.png)`

			`![Password tool](http://i.imgur.com/ZYkN70r.png)`

			`For more screenshots: [Click here](http://imgur.com/a/giKVt)`

Add code review section to readme 2016-10-01 03:58:26 +08:00			`## Code reviews`
			`If you have any improvements regarding our code.`
			`Please do the following`
			`- Clone us`
			`- Make your edits`
			`- Add your name to the contributors`
			`- Send a PR`

			`Or if you're feeling lazy, create an issue, and we'll think about it.`

Update Dockerfile and readme 2016-10-20 16:34:01 +08:00			`## Docker`
			To run passman with docker you can use `docker run -p 8080:80 -p 8443:443 brantje/passman`
Use different mount points for ssl 2016-10-25 04:52:40 +08:00			`To use your own SSL cert mount them as below`
Update Dockerfile and readme 2016-10-20 16:34:01 +08:00			`Example:`
Use different mount points for ssl 2016-10-25 04:52:40 +08:00			`docker run -p 8080:80 -p 8443:443 -v /directory/cert.pem:/data/ssl/cert.pem -v /directory/cert.key:/data/ssl/cert.key brantje/passman`
Add code review section to readme 2016-10-01 03:58:26 +08:00

Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			`## Development`
Add SASS info to readme 2016-10-20 00:08:27 +08:00			Passman uses a single `.js` file for the templates. This gives the benefit that we don't need to request every template with XHR.
			`For CSS we use SASS so you need ruby and sass installed.`
			`templates.js` and the CSS are build width `grunt`.
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00			To watch for changes use `grunt watch`
Typos and improvements on the readme 2016-10-17 01:35:22 +08:00			To run the unit tests install phpunit globally, and stup the envioronment variables on the `launch_phpunit.sh` script then just run that script any argumetns passed to this script will be forwarded to phpunit.
Update README.md (#28) Update README.md 2016-09-26 21:53:12 +08:00
			`## Main developers`
			`- Brantje`
			`- Animalillo`

			`## Contributors`
			`Add yours when creating a pull request!`
			`- None`
Update readme 2016-10-01 01:12:00 +08:00

			`## FAQ`
Update readme 2016-10-01 01:12:13 +08:00			`Are you adding something to check if malicious code is executing on the browser?`
Update readme 2016-10-01 01:12:00 +08:00			`No, because malitous code could edit the functions that check for malicious code.`