OwnPass

The OwnPass server application. This application provides an API as well as an interface for the accounts to manage their credentials.

Installation

From source (command line)

1. Clone the repository to a directory that is accessible by your webserver: https://github.com/ownpass/api-server.git
2. Enter the directory: cd api-server
3. Install composer dependencies: composer install --no-dev
4. Copy config/autoload/apigility.local.php.dist to config/autoload/apigility.local.php and fill in the correct settings.
5. Copy config/autoload/doctrine.local.php.dist to config/autoload/doctrine.local.php and fill in the correct settings.
6. Copy config/autoload/ownpass.local.php.dist to config/autoload/ownpass.local.php and fill in the correct settings.
7. Run php public/index.php orm:schema-tool:create to create the database.
8. Run php public/index.php ownpass:account:create to create an user account.
9. Run php public/index.php ownpass:oauth:create-application --name="Control Panel" --client=control-panel --force to create an OAuth application for the Control Panel.
10. Run php public/index.php ownpass:oauth:create-application --name="Chrome Extension" --client=chrome-extension --force to create an OAuth application for the Chrome Extension
11. Run php public/index.php ownpass:oauth:create-application --name="Firefox Extension" --client=firefox-extension --force to create an OAuth application for the Firefox Extension
12. Run php public/index.php ownpass:oauth:create-application --name="Internet Explorer Extension" --client=ie-extension --force to create an OAuth application for the Internet Explorer Extension

To enable development mode, copy config/development.config.php.dist to config/development.config.php and make sure to clear the cache in data/cache/. You could consider copying config/autoload/viewmanager.global.php to viewmanager.local.php and turn on errors so it becomes clear what errors occur.

Using docker (development only!)

1. Clone the repository to a working directory: git clone git@github.com:ownpass/ownpass.git
2. Enter the directory: cd ownpass
3. Start docker-compose: docker-compose up
4. Install composer dependencies: docker-compose run composer install
5. Copy config/autoload/apigility.local.php.dist to config/autoload/apigility.local.php and fill in the correct settings.
6. Copy config/autoload/doctrine.local.php.dist to config/autoload/doctrine.local.php and fill in the correct settings.
7. Copy config/autoload/ownpass.local.php.dist to config/autoload/ownpass.local.php and fill in the correct settings.
8. Run docker-compose exec phpserver php index.php orm:schema-tool:create to create the database.
9. Run docker-compose exec phpserver php index.php ownpass:account:create to create an user account.
10. Run docker-compose exec phpserver php index.php ownpass:oauth:create-application --name="Chrome Extension" --client=chrome-extension --force to create an OAuth application for the Chrome Extension
11. Run docker-compose exec phpserver php index.php ownpass:oauth:create-application --name="Firefox Extension" --client=firefox-extension --force to create an OAuth application for the Firefox Extension
12. Run docker-compose exec phpserver php index.php ownpass:oauth:create-application --name="Internet Explorer Extension" --client=ie-extension --force to create an OAuth application for the Internet Explorer Extension
13. Run docker-compose exec phpserver php index.php ownpass:generate-keys to create the public and private key.

Change log

Please see CHANGELOG for more information what has changed recently.

Testing

$ composer test

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

Community

There's a Gitter room where you can drop questions: https://gitter.im/ownpass/Lobby You can also find us on IRC. We're on the Freenode network in the channel #ownpass.

License

All rights reserved. The application is free to use but the rights of the source code are with the OwnPass team.