Initial post of server usage content.

Peter Hamilton 2016-12-01 15:27:05 -05:00
parent 2902ef9fde
commit 820cb1ac6a

13
Running-the-Server.md Normal file

@ -0,0 +1,13 @@
As discussed in the project README (see Server), the PyKMIP server is meant for testing and demonstration purposes only. While it does implement some security features and only supports connections over TLS, it currently stores all data in a simple file-backed SQLite database stored in `/tmp`. There are no guarantees that it will stand up to long term use, so it should not be used in production nor as a piece of critical infrastructure.
There are a couple of ways to run the server. There is a startup script in the project `bin` directory, which you can use:
$ bin/run_server.py
The default server log can be found in `/var/log/pykmip/server.log`, where you can see the startup logs and any connection/client activity.
You can also use the PyKMIP package entry point, as defined in `setup.py`:
$ pykmip-server
This behaves just like the `bin` script above.