e3fee2cf46
Prior to this commit, the Odoo documentation was mainly split between
two repositories: odoo/odoo/doc and odoo/documentation-user. Some bits
of documentation were also hosted elsewhere (e.g., wiki, upgrade, ...).
This was causing several problems among which:
- The theme, config, Makefile, and similar technical resources had to
be duplicated. This resulted in inconsistent layout, features, and
build environments from one documentation to another.
- Some pages did not fit either documentation as they were relevant
for both users and developers. Some were relevant to neither of the
two (e.g., DB management).
- Cross-doc references had to be absolute links and they broke often.
- Merging large image files in the developer documentation would bloat
the odoo/odoo repository. Some contributions had to be lightened to
avoid merging too many images (e.g., Odoo development tutorials).
- Long-time contributors to the user documentation were chilly about
going through the merging process of the developer documentation
because of the runbot, mergebot, `odoo-dev` repository, etc.
- Some contributors would look for the developer documentation in the
`odoo/documentation-user` repository.
- Community issues about the user documentation were submitted on the
`odoo/odoo` repository and vice-versa.
Merging all documentations in one repository will allow us to have one
place, one theme, one work process, and one set of tools (build
environment, ...) for all of the Odoo docs.
As this is a good opportunity to revamp the layout of the documentation,
a brand new theme replaces the old one. It features a new way to
navigate the documentation, centered on the idea of always letting the
reader know what is the context (enclosing section, child pages, page
structure ...) of the page they are reading. The previous theme would
quickly confuse readers as they navigated the documentation and followed
cross-application links.
The chance is also taken to get rid of all the technical dangling parts,
performance issues, and left-overs. Except for some page-specific JS
scripts, the Odoo theme Sphinx extension is re-written from scratch
based on the latest Sphinx release to benefit from the improvements and
ease future contributions.
task-2351938
task-2352371
task-2205684
task-2352544
Closes #945
198 lines
7.6 KiB
ReStructuredText
198 lines
7.6 KiB
ReStructuredText
|
||
==================================
|
||
Settings
|
||
==================================
|
||
|
||
Overview
|
||
========
|
||
|
||
The settings allow you to manage the configuration of your project.
|
||
|
||
.. image:: ./media/interface-settings.png
|
||
:align: center
|
||
|
||
Project name
|
||
============
|
||
|
||
The name of your project.
|
||
|
||
.. image:: ./media/interface-settings-projectname.png
|
||
:align: center
|
||
|
||
This defines the address that will be used to access your production database.
|
||
|
||
Addresses of your staging and development builds are derived from this name and assigned automatically.
|
||
However, when you change your project name, only future builds will use the new name.
|
||
|
||
.. _odoosh-gettingstarted-settings-collaborators:
|
||
|
||
Collaborators
|
||
=============
|
||
|
||
Manage the Github users who can access your project.
|
||
|
||
.. image:: ./media/interface-settings-collaborators.png
|
||
:align: center
|
||
|
||
There are two levels of users:
|
||
|
||
* Admin: has access to all features of Odoo.sh.
|
||
* User: does not have access to the project settings nor to the production and staging databases.
|
||
|
||
The user group is meant for developers who can make modifications in your code but are not allowed to access the
|
||
production data.
|
||
Users of this group cannot connect to the production and staging databases using the *1-click connect* feature,
|
||
but they can of course use their regular account on these databases if they have one, using their regular credentials.
|
||
|
||
In addition, they cannot use the webshell nor have access to the server logs.
|
||
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | | User | Admin |
|
||
+=====================+=================+===========+===========+
|
||
|Development | History | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | 1-click connect | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Logs | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Shell/SSH | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Mails | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Settings | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
|Production & Staging | History | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | 1-click connect | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Logs | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Shell/SSH | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Mails | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Monitoring | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Backups | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
| | Settings | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
|Status | | X | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
|Settings | | | X |
|
||
+---------------------+-----------------+-----------+-----------+
|
||
|
||
Public Access
|
||
=============
|
||
|
||
Allow public access to your development builds.
|
||
|
||
.. image:: ./media/interface-settings-public.png
|
||
:align: center
|
||
|
||
If activated, this option exposes the Builds page publicly, allowing visitors to connect to your development builds.
|
||
|
||
In addition, visitors have access to the logs, shell and mails of your development builds.
|
||
|
||
Production and staging builds are excluded, visitors can only see their status.
|
||
|
||
.. _odoosh-gettingstarted-settings-modules-installation:
|
||
|
||
|
||
Custom domains
|
||
==============
|
||
|
||
To configure additional domains please refer to the corresponding branch's :ref:`settings tab <odoosh-gettingstarted-branches-tabs-settings>`.
|
||
|
||
.. _odoosh-gettingstarted-settings-submodules:
|
||
|
||
Submodules
|
||
==========
|
||
|
||
Configure the deploy keys for the private repositories you use
|
||
as submodules in your branches to allow Odoo.sh to download them.
|
||
|
||
.. Warning::
|
||
These settings are required for **private repositories** only.
|
||
If you are looking on how to set up your submodules,
|
||
instructions are available in the chapter :ref:`Submodules <odoosh-advanced-submodules>` of this documentation.
|
||
|
||
.. image:: ./media/interface-settings-submodules.png
|
||
:align: center
|
||
|
||
When a repository is private, it is not possible to publicly download its branches and revisions.
|
||
For that reason, you need to configure a deploy key for Odoo.sh,
|
||
so the remote Git server allows our platform to download the revisions
|
||
of this private repository.
|
||
|
||
To configure the deploy key for a private repository, proceed as follows:
|
||
|
||
* in the input, paste the SSH URL of your private sub-repository and click on *Add*,
|
||
|
||
* e.g. *git@github.com:USERNAME/REPOSITORY.git*
|
||
* it can be another Git server than Github, such as Bitbucket, Gitlab or even your own self-hosted server
|
||
|
||
* copy the public key,
|
||
|
||
* it should look like *ssh-rsa some...random...characters...here...==*
|
||
|
||
* in the settings of the private sub-repository, add the public key amongst the deploy keys.
|
||
|
||
* Github.com: :menuselection:`Settings --> Deploy keys --> Add deploy key`
|
||
* Bitbucket.com: :menuselection:`Settings --> Access keys --> Add key`
|
||
* Gitlab.com: :menuselection:`Settings --> Repository --> Deploy Keys`
|
||
* Self-hosted: append the key to the git user’s authorized_keys file in its .ssh directory
|
||
|
||
Storage Size
|
||
============
|
||
|
||
This section shows the storage size used by your project.
|
||
|
||
.. image:: ./media/interface-settings-storage.png
|
||
:align: center
|
||
|
||
Storage size is computed as follows:
|
||
|
||
* the size of the PostgreSQL database
|
||
|
||
* the size of the disk files available in your container: database filestore, sessions storage directory...
|
||
|
||
.. Warning::
|
||
In case you want to analyze disk usage, you can run the tool `ncdu <https://dev.yorhel.nl/ncdu/man>`_ in your Web Shell.
|
||
|
||
Should your production database size grow to exceed what's provisioned in your subscription, it
|
||
will automatically be synchronized with it.
|
||
|
||
Database Workers
|
||
================
|
||
|
||
Additional database workers can be configured here. More workers help increase the load your
|
||
production database is able to handle. If you add more, it will automatically be synchronized
|
||
with your subscription.
|
||
|
||
.. image:: ./media/interface-settings-workers.png
|
||
:align: center
|
||
|
||
.. Warning::
|
||
Adding more workers will not magically solve all performance issues. It only allows the server
|
||
to handle more connections at the same time. If some operations are unusually slow, it's most
|
||
likely a problem with the code, if it's not due to your own customizations you can open a ticket
|
||
`here <https://www.odoo.com/help>`_.
|
||
|
||
Staging Branches
|
||
================
|
||
|
||
Additional staging branches allow you to develop and test more features at the same time. If you
|
||
add more, it will automatically be synchronized with your subscription.
|
||
|
||
.. image:: ./media/interface-settings-staging-branches.png
|
||
:align: center
|
||
|
||
Activation
|
||
==========
|
||
|
||
Shows the status of the project's activation. You can change the project's activation code if needed.
|
||
|
||
.. image:: ./media/interface-settings-activation.png
|
||
:align: center
|