rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated docs to refer back to website

Browse source
This commit is contained in:
jtc42 2019-07-03 16:35:24 +01:00
parent a325115c09
commit 7552e4662b
2 changed files with 10 additions and 80 deletions
Download patch file Download diff file Expand all files Collapse all files

47
docs/source/quickstart.rst
View file

@ -4,7 +4,7 @@ Quickstart
Install
-------
Quick-installer
Stable installation
+++++++++++++++
For most users, this is the reccommended installation method.
@ -12,13 +12,7 @@ For most users, this is the reccommended installation method.
- See the `GitLab repo <https://gitlab.com/openflexure/openflexure-microscope-installer>`_ for details.
- Follow on-screen prompts
Really-quick installer
^^^^^^^^^^^^^^^^^^^^^^
The installer script can run with all default settings applied, removing all user prompts.
- Run ``curl -LSs get.openflexure.org/microscope |sudo bash -s -- -y``
Developer installer
Developer installation
^^^^^^^^^^^^^^^^^^^
The installer script can pull the latest development package from our git repository, and use install into a developer environment using Poetry.
@ -27,38 +21,13 @@ The installer script can pull the latest development package from our git reposi
Manual installation
+++++++++++++++++++
- (Recommended) create a virtual environment
- ``pip3 install virtualenv``
- ``mkdir ~/.openflexure``
- ``python3 -m virtualenv ~/.openflexure/envmicroscope``
- Activate with ``source /.openflexure/envmicroscope/bin/activate``
- (Recommended) create and activate a virtual environment
- Install non-python dependencies with ``sudo apt-get install libatlas-base-dev libjasper-dev libjpeg-dev``
- **Users:** Install module by running ``pip install openflexure-microscope``
- **Developers:** Install `Poetry <https://github.com/sdispater/poetry>`_, clone this repo, and ``poetry install`` from inside the repo.
- Install `Poetry <https://github.com/sdispater/poetry>`_, clone this repo, and ``poetry install`` from inside the repo.
API Server
----------
Managing the server
-------------------
If you use the auto-installer, a system.d service will be generated automatically, and you will be prompted to enable it at startup.
The service can be controlled with the following commands:
Managing the server through the installer script's CLI is documented `on our website <https://openflexure.gitlab.io/projects/microscope/#managing-the-microscope-server>`_.
=================== ====
**Start** ``sudo systemctl start ofmserver``
**Stop** ``sudo systemctl stop ofmserver``
**Restart** ``sudo systemctl restart ofmserver``
**Check status** ``sudo systemctl status ofmserver``
**Disable on-boot** ``sudo systemctl disable ofmserver``
**Enable on-boot** ``sudo systemctl enable ofmserver``
=================== ====
Manually starting the server with Gunicorn
++++++++++++++++++++++++++++++++++++++++++
This can be especially useful for developers, giving more immediate feedback on the status of the server.
- Ensure Gunicorn is installed to the current environment (``pip install gunicorn``)
- Run ``gunicorn --threads 5 --workers 1 --graceful-timeout 3 --bind 0.0.0.0:5000 openflexure_microscope.api.app:app``
- We spawn 5 threads to handle simultaneous connections
- We spawn a single worker as only one process can access the Pi camera simultaneously
- We shorten the graceful-timeout to 3 seconds, to avoid stalling if a camera feed connection is active
- Binding to 0.0.0.0:5000 opens the server up on port 5000 to devices outside of localhost
This includes starting the server as a background service, as well as starting a development server with real-time debug logging.