diff options
| -rw-r--r-- | doc/src/deployment-server-http-server-setup.qdoc | 18 | ||||
| -rw-r--r-- | doc/src/deployment-server-installation.qdoc | 14 | ||||
| -rw-r--r-- | doc/src/deployment-server-reference.qdoc | 6 | ||||
| -rw-r--r-- | doc/src/deployment-server.qdoc | 12 |
4 files changed, 25 insertions, 25 deletions
diff --git a/doc/src/deployment-server-http-server-setup.qdoc b/doc/src/deployment-server-http-server-setup.qdoc index 6921362..a155b3d 100644 --- a/doc/src/deployment-server-http-server-setup.qdoc +++ b/doc/src/deployment-server-http-server-setup.qdoc @@ -40,8 +40,8 @@ The Deployment Server can be set up in combination with a regular web server: Ap Nginx. This web server can be used to reduce the number of open ports or to add a layer of SSL encryption. -In the Django version that is used for the deployment server, there are two possible setups for - running with another web server: +There are two possible setups for running with another web server in the Django version used for +the Deployment Server: \list \li reverse proxy setup - which we describe here \li WSGI setup - for brevity, this setup is left out of scope, as it is similar in functionality @@ -108,7 +108,7 @@ $HTTP["url"] =~ "^/<url_prefix>/" { \endcode Where \e{<url_prefix>} is the same as in \e{settings.py} file, and \e{<port>} is the port on which the -deployment server instance is running. +Deployment Server instance is running. Finally, reload the Lighttpd server's configuration. @@ -125,17 +125,17 @@ The code that needs to be added is: \endcode Where \e{<url_prefix>} is the same as in \e{settings.py} file, and \e{<port>} is the port on which the -deployment server instance is running. +Deployment Server instance is running. -\section1 Serving static files outside of django app +\section1 Serving Static Files Outside of Django App -It is possible to speed up working of the admin pages of deployment server by serving static files -separately. In order to achieve that, webserver should be configured to serve \e{static/} subdirectory of -deployment server installation as \e{static/} subdirectory of the instance. (If deployment server is +It is possible to speed up working of the admin pages of the Deployment Server by serving static files +separately. In order to achieve that, web server should be configured to serve \e{static/} subdirectory of +the Deployment Server installation as \e{static/} subdirectory of the instance. (If the Deployment Server is hosted as \e{http://deployment.server.name/}, then \e{static/} directory in the sources should be redirected to \e{http://deployment.server.name/static/}, while bypassing the django app.) -After configuring that, static files collection should be performed with this command: +After configuring that, static files collection should be performed using the following command: \code ./venv/bin/python manage.py collect static diff --git a/doc/src/deployment-server-installation.qdoc b/doc/src/deployment-server-installation.qdoc index 4cb0517..7937992 100644 --- a/doc/src/deployment-server-installation.qdoc +++ b/doc/src/deployment-server-installation.qdoc @@ -37,8 +37,8 @@ \section1 Set up the Server in a Virtual Environment - Before you install the dependencies in the Python virtual environment, you must install the - \c{libffi-dev}, \c{python-pkg-resources}, \c{python-dev} and \c{libssl-dev} packages. Next, + Before you install the dependencies in the Python virtual environment, you need to install the + \c{libffi-dev}, \c{python-pkg-resources}, \c{python-dev} and \c{libssl-dev} packages. Then, prepare the virtual environment: \code @@ -50,7 +50,7 @@ before you run the server. One setting group to note is category icon resizing and decolorization settings. They are: - \c{ICON_SIZE_X}, \c{ICON_SIZE_Y} and \c{ICON_DECOLOR}. \c{ICON_DECOLOR} is False by default, and it + \c{ICON_SIZE_X}, \c{ICON_SIZE_Y}, and \c{ICON_DECOLOR}. \c{ICON_DECOLOR} is False by default, and it regulates stripping the category icon of color and alpha channel and the subsequent application of the same image as an alpha channel instead. @@ -59,7 +59,7 @@ so you should be aware that any uploaded icon will be limited to this size, unless the server is reconfigured. - Since package downloads are done via temporary files, you need to setup a cron-job to remove + Since package downloads are done through temporary files, you need to setup a cron-job to remove these temporary files periodically. The cron-job should be triggered every \c{settings.APPSTORE_DOWNLOAD_EXPIRY/2} minutes; it needs to run: @@ -80,7 +80,7 @@ \section1 Prepare Your Databases on the Server - Before you run the server, first, you must prepare the databases. Also, you need to create an administrative user. + Before you run the server, first, you need to prepare the databases. Also, you need to create an administrative user. \code ./manage.py makemigrations @@ -100,8 +100,8 @@ ./manage.py runserver 0.0.0.0:8080 \endcode - This command starts the server on port 8080, and is reachable by anyone. You can modify the - listening address to another address that suits your use case. + This command starts the server on port 8080, and is reachable by anyone. You can replace the + listening address with another one that suits your use case. \section1 Maintain the Server diff --git a/doc/src/deployment-server-reference.qdoc b/doc/src/deployment-server-reference.qdoc index 88902d4..458fc24 100644 --- a/doc/src/deployment-server-reference.qdoc +++ b/doc/src/deployment-server-reference.qdoc @@ -103,7 +103,7 @@ \section2 login - Logs onto the deployment server with the given username and password. + Logs onto the Deployment Server with the given username and password. Either an IMEI or a unique hardware identifier, such as a MAC address, must be provided. This call is necessary to be able to download apps. \table @@ -141,7 +141,7 @@ \endtable \section2 logout - Logs out the currently logged-in user from the deployment server. + Logs out the currently logged-in user from the Deployment Server. Returns a JSON object with the following fields and values. \table @@ -286,7 +286,7 @@ \row \li failed \li - \li An error has occurred, dheck the error field for more information. + \li An error has occurred, check the error field for more information. \row \li error \li Text. diff --git a/doc/src/deployment-server.qdoc b/doc/src/deployment-server.qdoc index c3e7961..38f8ea3 100644 --- a/doc/src/deployment-server.qdoc +++ b/doc/src/deployment-server.qdoc @@ -41,21 +41,21 @@ that are available for installation by a Qt Application Manager instance, running on a target device connected to a network. The UI counterpart for the Deployment Server is the Downloads app in the Neptune 3 UI. Together, the Deployment Server and the Downloads app enable you to install - different apps that are available in the server via network. + different apps available on the server through network. The key scenario for these components is to install apps during the integration testing process. Additionally, the code can also be used as a reference implementation for a fully-featured server, and a new Downloads app on the target device for production. - The Deployment Server works with the Application Installer in the Qt Application Manager and + The Deployment Server works with the Application Installer in \l{Qt Application Manager} and acts as an installation source for \c{http://} and \c{https://} schemes. In addition to application packages, the Deployment Server also hosts meta information about each package, - that is used by the Downloads app to visualize the choices available for the user to select. + that is used by Downloads app to visualize the choices available for a user to select. This meta information is stored in the form of tags and other information in the package header, according to the Qt Application Manager’s package format. When a package is uploaded - to the server, the package header is parsed, associated with that package, and then sent to a - Downloads app, that queries for a list of available apps. Using this information, a Downloads - app can inform users about apps that are available and even hide those that are not compatible + to the server, the package header is parsed, associated with that package, and then sent to the + Downloads app, that queries for a list of available apps. Using this information, the Downloads + app can inform users about the available apps and even hide those that are not compatible with the target installation. The figure below illustrates this installation scenario. \image deployment-server-installation-handshake.png "Install an App via the Deployment Server" |