server.rst 1.75 KB
Newer Older
militarpancho's avatar
militarpancho committed
1
2
3
Senpy server
============

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
4
The senpy server is launched via the `senpy` command:
militarpancho's avatar
militarpancho committed
5

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
6
::
militarpancho's avatar
militarpancho committed
7

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
8
9
10
    usage: senpy [-h] [--level logging_level] [--debug] [--default-plugins]
                [--host HOST] [--port PORT] [--plugins-folder PLUGINS_FOLDER]
                [--only-install]
militarpancho's avatar
militarpancho committed
11

J. Fernando Sánchez's avatar
J. Fernando Sánchez committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    Run a Senpy server

    optional arguments:
    -h, --help            show this help message and exit
    --level logging_level, -l logging_level
                            Logging level
    --debug, -d           Run the application in debug mode
    --default-plugins     Load the default plugins
    --host HOST           Use 0.0.0.0 to accept requests from any host.
    --port PORT, -p PORT  Port to listen on.
    --plugins-folder PLUGINS_FOLDER, -f PLUGINS_FOLDER
                            Where to look for plugins.
    --only-install, -i    Do not run a server, only install plugin dependencies


When launched, the server will recursively look for plugins in the specified plugins folder (the current working directory by default).
The default server includes a playground and an endpoint with all plugins found.

By default, senpy will listen only on the `127.0.0.1` address.
That means you can only access the API from your (or localhost).
You can listen on a different address using the `--host` flag.
The default port is 5000.
You can change bothbut you can change it using the `--port` flag. 

For instance, to accept connections on port 6000 on any interface:

.. code:: bash

    senpy --host 0.0.0.0 --port 6000

For more options, see the `--help` page.


Customizing senpy
=================
Senpy is built on top of Flask, the web framework.
Although it is not the recommendad way, you may customize senpy by extending the extensions, blueprints and modules provided in the senpy module.