Mal
/
ringfinger
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Readme added

This commit is contained in:
Mal 2020-08-19 14:21:35 +02:00
parent 0f026de5da
commit 4752fedc5c
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md Normal file
View File

@ -0,0 +1,19 @@
# Ringfinger
A restfull keyring API with web UI to share your jabber fingerprints with the people you want.
Create an account, store your jabber fingerprints and share it with your friends. There is no need to type in your 64 chars long fingerprint for each of your friends. Just enter it once and decide which people you want to share your keyring with.
# Setup
Clone or copy the ringfinger folder to the location folder of your webserver. Move into the ringfinger folder an generate the cache:
> make build
## Webserver configuration
Despite your basic setup with PHP and MySQL/MariaDB your webserver has to to rewrite all requests that access the path `/ringfinger/api/v1/...` to `/ringfinger/api/v1/index.php` to make the API working.
### NGINX
Add the following line to your nginx.conf or to a separate file that will be included by the nginx.conf:
> rewrite /ringfinger/api/v1/.* /ringfinger/api/v1/index.php;
**Also make sure you deny the access to /ringfinger/data for all!**