Deploy your Bitnami Odoo Stack on CenturyLink Cloud now! Launch Now

Description

Odoo is an open source ERP and CRM platform, formerly known as OpenERP, that can connect a wide variety of business operations such as sales, supply chain, finance, and project management.

First steps with the Bitnami Odoo Stack

Welcome to your new Bitnami application running on CenturyLink Cloud! Here are a few questions (and answers!) you might need when first starting with your application.

What credentials do I need?

You need two sets of credentials:

  • The application credentials that allow you to log in to your new Bitnami application. These credentials consist of a username and password.
  • The server credentials that allow you to log in to your CenturyLink Cloud server using an SSH client and execute commands on the server using the command line. These credentials consist of an SSH username and key.

What is the administrator username set for me to log in to the application for the first time?

Username: user@example.com

What SSH username should I use for secure shell access to my application?

SSH username: bitnami

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

Remember that if you need to open some ports you can follow the instructions given in the FAQ to learn how to open the server ports for remote access.

Port 22 is the default port for SSH connections.

Bitnami opens some ports for the main servers. These are the ports opened by default: 80, 443.

What is the default configuration?

Odoo application

A new database will be created during the deployment process. The Odoo package is installed at /opt/bitnami/apps/odoo/lib/odoo-version.egg.

Odoo configuration file

The Odoo server configuration file is at /opt/bitnami/apps/odoo/conf/odoo-server.conf.

NOTE: The configuration file name changed since the Odoo 10 version was released. If you are using a prior version, the configuration file is at /opt/bitnami/apps/odoo/conf/openerp-server.conf.

Odoo servers

By default, two Odoo servers run:

  • odoo_no_multi_process, which controls the scheduled actions

  • odoo_gevent, which handles the Instant Message connections. Its port can be found in the Odoo configuration file in the longpolling_port variable.

Odoo logs

The Odoo logs are located at /opt/bitnami/apps/odoo/log.

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without any service name arguments to start all services:

$ sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the service name as argument:

$ sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

$ sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh

How to find the master password?

For security reasons the master password is randomly generated during the installation of the application. To find the master password, view the /opt/bitnami/apps/odoo/conf/odoo-server.conf configuration file and search for the line below, which contains the password:

admin_passwd = PASSWORD

To set another password:

  • Edit the /opt/bitnami/apps/odoo/conf/odoo-server.conf file:

      $ sudo nano /opt/bitnami/apps/odoo/conf/odoo-server.conf
    
  • Modify the line below and replace the PASSWORD placeholder with your desired password:

      admin_passwd = PASSWORD
    
  • Restart the Apache server:

      $ sudo /opt/bitnami/ctlscript.sh restart apache
    
NOTE: The configuration file name changed since the Odoo 10 version was released. If you are using a prior version, the configuration file is at /opt/bitnami/apps/odoo/conf/openerp-server.conf.

How to configure the Odoo timezone?

The Odoo server is forced to be UTC. The rendering of datetime values in the user's timezone is meant to be done on the client-side exclusively. You can configure the timezone per user in the user's "Settings" panel.

Odoo preferences

How to configure outbound email settings?

In order to configure outbound email, follow the steps below:

  • Browse to the Settings -> General settings -> Configure outgoing email server -> Create menu.

  • Fill the required information. The settings below configure Odoo to send emails through a Gmail account. Replace USERNAME and PASSWORD with your Gmail account username and password respectively.

       Description: smtp.gmail.com
    
       #### Connection Information
       SMTP Server: smtp.gmail.com
       SMTP Port: 587
    
       #### Security and Authentication
       Connection Security: TLS
       Username: USERNAME@gmail.com
       Password: PASSWORD
    
  • Save the changes.

To configure the application to use other third-party SMTP services for outgoing email, such as SendGrid or Mandrill, refer to the FAQ.

Troubleshooting Gmail SMTP issues

If you are using Gmail as the outbound email server and you are not able to send email correctly, Google may be blocking sign-in attempts from your apps or devices. Depending on whether or not you use Google Apps, the steps to correct this will differ.

For Google Apps users

If you are a Google Apps user, you will need your administrator to allow users to change the policy for less secure apps. If you are a Google Apps administrator, follow these steps:

  • Browse to the Google Apps administration panel.

  • Click on "Security" and then "Basic settings".

  • Look for the section "Less secure apps" and then click on "Go to settings for less secure apps".

  • Select "Allow users to manage their access to less secure apps".

For other Google users

If you do not use Google Apps, follow the steps in the following sections, depending on whether 2-step verification has been enabled on the account or not.

If 2-step verification has not been enabled on the account, follow these steps:

  • Browse to the "Less secure apps" page and log in using the account you are having problems with. This option is typically required by many popular email clients, such as Outlook and Thunderbird, and should not be considered unsafe.

  • Select the "Turn on" option.

    Security settings

If 2-step verification has been enabled on the account, you have to generate an app password. Follow these steps:

  • Browse to the "App passwords" page.

  • Click "Select app" and choose the app you're using.

  • Click "Select device" and choose the device you're using.

  • Click the "Generate" button.

  • Enter the app password on your device.

  • Click the "Done" button.

Here are other options you may try:

  • Browse to the web version of Gmail and sign in to your account. Once you're signed in, try to enable access for the application again.

  • Browse to the "Unlock Captcha" function page and sign in with your Gmail username and password.

  • Disable IMAP from the Gmail web server interface and enable it again.

    IMAP settings

How to install a plugin on Odoo?

NOTE: The steps in this section assume that you have logged in to Odoo.com. Log in now, or sign up for new account.

How to install a plugin on Odoo from the Admin panel?

You can install modules and addons from the admin panel of the application. To install a new module in Odoo, follow the next steps:

  • Log in to the Odoo administration panel and on the top menu bar, click "Apps":

    Install plugins from Administration panel

  • In the Apps menu, you will see the Odoo plugin catalog. Search for the plugin you want to install.

    Select an Odoo plugin to install

  • Click the "Install" button in the plugin you want to enable. If you are already logged in Odoo.com the installation will be automatically done. The plugin will appear as "Installed":

    Install a plugin on Odoo

How to manually install a plugin on Odoo?

If you can't find the plugin you want to install in the Odoo plugin catalog, you can upload and install a module from the command line. To do so, follow these instructions:

  • Navigate to the Odoo plugin catalog and select the version of the application you have installed (in this case, v10.0):

    Odoo Apps catalog

  • Select the plugin you want to install and download it (make sure that you are downloading a plugin compatible with the current version of Odoo).

    Download an Odoo plugin

  • Connect to the Odoo server through SSH. Refer to the FAQ for more information on this.
  • Once you have accessed the server, change to the following directory (note that xyz are placeholders of the current Odoo version):

    $ cd /apps/odoo/lib/odoo-10.0.xyz.egg/odoo
    
  • Change the permissions of the addons directory so you can move folders and files into it. Execute the following to get the right permissions:

     $ sudo chmod 777 /addons
    
  • Upload the unzipped directories and files. Follow these instructions to upload files to the server with SFTP.
  • Once you have uploaded the module into the /apps/odoo/lib/odoo-10.0.xyz.egg/odoo/addons directory, you need to make sure that you can manage the uploaded files as the daemon user. Execute the following command:

     $ sudo chown -R daemon:daemon addons/MODULE-FOLDER-NAME
    
  • Restore the permissions to the /apps/odoo/lib/odoo-10.0.xyz.egg/odoo/addons directory:

     $ sudo chmod 755 addons/
    
  • Log in to the Odoo administration panel and in the top menu bar, click "Settings":

Navigate to the Settings section

  • In the right corner, you will find a description of Odoo. Under that information, you will see both the "Activate developer mode" and the "Activate developer mode (with assets)". Click on any of these links (the "Activate the developer mode (with assets)") is recommended:

Activate the developer mode

NOTE: When you have the developer mode activated, you can see a bug icon in the upper right corner of the screen.

Developer mode activated

  • In the top menu bar, click "Apps". In the left side menu of the resulting screen, click "Update Apps List". Click "Update" in the Module Update dialog to start the process.

    Apps menu: update Apps list

  • Click the "Apps" menu item. The plugin should appear in the Apps list:

Plugin installed

  • Click the "Install" button in the plugin you want to enable. If you are already logged in Odoo.com the installation will be automatically done. The plugin will appear as "Installed":

    Install a plugin on Odoo

How to install the Live Chat module?

Follow these steps:

  • In the administration panel, click the "Apps" menu located in the upper-left margin and click "Install" button in the Website Live Chat module.

Install Website Live Chat Module

How to install Wkhtmltopdf?

Wkhtmltopdf is necessary for some Odoo functionality. To install it on your system, follow the steps described below.

  • Download the latest version of the package from the Wkhtmltopdf project releases page and install it. Replace the X.Y.Z placeholders with the latest version available for your platform.
NOTE: The latest version available of Wkhtmltopdf is not compatible with some Odoo functionalities in some Linux distributions. Please check what is the recommended version for your Linux distribution in the Odoo GitHub repository.
      $ wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/X.Y.Z/wkhtmltox-X.Y.Z_linux-generic-amd64.tar.xz
      $ tar -xvf wkhtmltox-X.Y.Z_linux-generic-amd64.tar.xz
  • Copy the binaries to the /usr/bin directory:

       $ sudo cp ./wkhtmltox/bin/wkhtmltoimage /usr/bin/
       $ sudo cp ./wkhtmltox/bin/wkhtmltopdf /usr/bin/
    
  • (Odoo 11.x only) Install the necessary dependencies:
    • Debian:

       $ sudo apt-get install zlib1g fontconfig libxrender1 libfreetype6 libxext6 libx11-6
      
    • CentOS:

       $ sudo yum install zlib-devel fontconfig libXext libXrender freetype freetype-devel libX11-devel
      
  • Restart all running servers:

     $ sudo sudo /opt/bitnami/ctlscript.sh restart
     $ sudo sudo /opt/bitnami/ctlscript.sh restart apache
    

Now, PDF options will be available in your Odoo application.

Troubleshooting

If you experience issues with display resolution on Linux platforms, they could be related to the xfonts-75dpi or xfonts-100dpi packages. Uninstall them by executing:

$ sudo dpkg --remove --force-depends xfonts-75dpi
$ sudo dpkg --remove --force-depends xfonts-100dpi

How to create a full backup of Odoo?

Backup

The Bitnami Odoo Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

  • Change to the directory in which you wish to save your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Create a compressed file with the stack contents:

      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    
  • Restart all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

  • Change to the directory containing your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Move the current stack to a different location:

      $ sudo mv /opt/bitnami /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directoryv

      $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to upgrade the Bitnami Odoo Stack?

It is strongly recommended that you create a backup before starting the update process. If you have important data, it is advisable that you create and try to restore a backup to ensure that everything works properly.

WARNING: The process described in this section, only works in the same major version of Odoo (i.e. upgrading from Odoo11.x.y to Odoo11.x.z). If you want to upgrade between Odoo Major versions (i.e. upgrading from Odoo10.x to Odoo11.y) please check the Odoo Community Forum and this Odoo Community Association project.
  • Go to your Odoo installation and instead of logging in, click "Manage Databases".

  • From this web interface, create a backup of the bitnami_odoo database.

  • Stop the running application.

  • Install a new version of Bitnami Odoo (or deploy a new server).

  • From the "Manage Databases" interface, restore the bitnami_odoo database.

  • Stop all servers except PostgreSQL and migrate your data as explained in the section on migration.

NOTE: The default database name changed since the Odoo 10 version was released. If you are upgrading a prior version, the default database name is bitnami_openerp.

Upgrade only Odoo in the Bitnami Odoo Stack

Linux and Mac OS X

This approach is not recommended because a new Odoo version may have new dependencies not included in your base stack.

NOTE: If you are using Odoo 11 or later, you need to replace this /opt/bitnami/python/bin/python file with /opt/bitnami/python/bin/python3.
  • Download and install the latest Odoo version. For example:

    $ cd /tmp/
    $ wget http://nightly.odoo.com/10.0/nightly/src/odoo_10.0.latest.tar.gz
    $ tar zxvf odoo_10.0.latest.tar.gz
    $ cd odoo-10.0-VERSION
    $ sudo python setup.py install --prefix=/opt/bitnami/apps/odoo --install-lib=/opt/bitnami/apps/odoo/lib
    $ sudo chown -R daemon:daemon /opt/bitnami/apps/odoo/lib
    
  • Change the line

     #!/opt/bitnami/python/bin/.python2.7.bin
    

    to

     #!/opt/bitnami/python/bin/python
    

    in the /opt/bitnami/apps/odoo/bin/odoo-bin file.

  • Update your configuration to point to this version of Odoo. Edit the /opt/bitnami/apps/odoo/conf/odoo-server.conf file and replace the addons path to point to the new Odoo version.

Migrate data to the new Odoo installation

Once your Odoo installation have been updated, follow the steps below to migrate data to the new installation.

  • Stop monit and other services

     $ sudo monit quit
     $ sudo /opt/bitnami/ctlscript.sh stop
     $ sudo /opt/bitnami/ctlscript.sh start postgresql
    
  • Start the Odoo server with the following parameters:

     $ sudo su daemon -c "/opt/bitnami/python/bin/python /opt/bitnami/apps/odoo/bin/odoo-bin -c /opt/bitnami/apps/odoo/conf/odoo-server.conf --workers 0 -d bitnami_odoo -u all &"
    
  • Wait until the server is completely started and the modules updated. You can check the start-up status in the Odoo log file as shown below:

     $ sudo tail -f /opt/bitnami/apps/odoo/log/production.log
    

    The upgrade process is finished when the messages "INFO bitnami_odoo odoo.service: Hit CTRL-C again or send a second signal to force the shutdown" or "Odoo waiting for connections" appear in the log file.

  • Start all the servers:

    $ sudo /opt/bitnami/ctlscript.sh start
    

Remember that when importing the data, you will also be importing the Odoo users, including the admin user and its password.

NOTE: The Odoo server configuration file, the Odoo log file and the default database name changed since Odoo 10 version. If you are using a prior version, the Odoo server configuration file is at /opt/bitnami/apps/odoo/conf/openerp-server.conf, the Odoo log file is at /opt/bitnami/apps/odoo/log/openerp-server.log and the default database name is bitnami_openerp.

How to create an SSL certificate?

OpenSSL is required to create an SSL certificate. A certificate request can then be sent to a certificate authority (CA) to get it signed into a certificate, or if you have your own certificate authority, you may sign it yourself, or you can use a self-signed certificate (because you just want a test certificate or because you are setting up your own CA).

Follow the steps below:

  • Generate a new private key:

     $ sudo openssl genrsa -out /opt/bitnami/apache2/conf/server.key 2048
    
  • Create a certificate:

     $ sudo openssl req -new -key /opt/bitnami/apache2/conf/server.key -out /opt/bitnami/apache2/conf/cert.csr
    
    IMPORTANT: Enter the server domain name when the above command asks for the "Common Name".
  • Send cert.csr to the certificate authority. When the certificate authority completes their checks (and probably received payment from you), they will hand over your new certificate to you.

  • Until the certificate is received, create a temporary self-signed certificate:

     $ sudo openssl x509 -in /opt/bitnami/apache2/conf/cert.csr -out /opt/bitnami/apache2/conf/server.crt -req -signkey /opt/bitnami/apache2/conf/server.key -days 365
    
  • Back up your private key in a safe location after generating a password-protected version as follows:

     $ sudo openssl rsa -des3 -in /opt/bitnami/apache2/conf/server.key -out privkey.pem
    

    Note that if you use this encrypted key in the Apache configuration file, it will be necessary to enter the password manually every time Apache starts. Regenerate the key without password protection from this file as follows:

     $ sudo openssl rsa -in privkey.pem -out /opt/bitnami/apache2/conf/server.key
    

Find more information about certificates at http://www.openssl.org.

How to enable HTTPS support with SSL certificates?

NOTE: The steps below assume that you are using a custom domain name and that you have already configured the custom domain name to point to your cloud server.

Bitnami images come with SSL support already pre-configured and with a dummy certificate in place. Although this dummy certificate is fine for testing and development purposes, you will usually want to use a valid SSL certificate for production use. You can either generate this on your own (explained here) or you can purchase one from a commercial certificate authority.

Once you obtain the certificate and certificate key files, you will need to update your server to use them. Follow these steps to activate SSL support:

  • Use the table below to identify the correct locations for your certificate and configuration files.

    Variable Value
    Current application URL https://[custom-domain]/
      Example: https://my-domain.com/ or https://my-domain.com/appname
    Apache configuration file /opt/bitnami/apache2/conf/bitnami/bitnami.conf
    Certificate file /opt/bitnami/apache2/conf/server.crt
    Certificate key file /opt/bitnami/apache2/conf/server.key
    CA certificate bundle file (if present) /opt/bitnami/apache2/conf/server-ca.crt
  • Copy your SSL certificate and certificate key file to the specified locations.

    NOTE: If you use different names for your certificate and key files, you should reconfigure the SSLCertificateFile and SSLCertificateKeyFile directives in the corresponding Apache configuration file to reflect the correct file names.
  • If your certificate authority has also provided you with a PEM-encoded Certificate Authority (CA) bundle, you must copy it to the correct location in the previous table. Then, modify the Apache configuration file to include the following line below the SSLCertificateKeyFile directive. Choose the correct directive based on your scenario and Apache version:

    Variable Value
    Apache configuration file /opt/bitnami/apache2/conf/bitnami/bitnami.conf
    Directive to include (Apache v2.4.8+) SSLCACertificateFile "/opt/bitnami/apache2/conf/server-ca.crt"
    Directive to include (Apache < v2.4.8) SSLCertificateChainFile "/opt/bitnami/apache2/conf/server-ca.crt"
    NOTE: If you use a different name for your CA certificate bundle, you should reconfigure the SSLCertificateChainFile or SSLCACertificateFile directives in the corresponding Apache configuration file to reflect the correct file name.
  • Once you have copied all the server certificate files, you may make them readable by the root user only with the following commands:

     $ sudo chown root:root /opt/bitnami/apache2/conf/server*
    
     $ sudo chmod 600 /opt/bitnami/apache2/conf/server*
    
  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart the Apache server.

You should now be able to access your application using an HTTPS URL.

How to force HTTPS redirection with Apache?

Add the following to the top of the /opt/bitnami/apps/odoo/conf/httpd-prefix.conf file:

RewriteEngine On
RewriteCond %{HTTPS} !=on
RewriteRule ^/(.*) https://%{SERVER_NAME}/$1 [R,L]

After modifying the Apache configuration files:

  • Open port 443 in the server firewall. Refer to the FAQ for more information.

  • Restart Apache to apply the changes.

How to debug Apache errors?

Once Apache starts, it will create two log files at /opt/bitnami/apache2/logs/access_log and /opt/bitnami/apache2/logs/error_log respectively.

  • The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

  • The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

If no error is found, you will see a message similar to:

Syntax OK

How to find the PostgreSQL database credentials?

How to connect to the PostgreSQL database?

You can connect to the PostgreSQL database from the same computer where it is installed with the psql client tool.

$ psql -U postgres

You will be prompted to enter the *postgres* user password. This is the same as the [application password](/centurylink/faq#how-to-find-application-credentials).

How to add new databases?

Odoo include a built-in feature to add new databases from the "Manage databases" section.

In order to enable the Odoo scheduler for any database different from the default one (bitnami_odoo), add the new database in the file /opt/bitnami/apps/odoo/conf/odoo-server.conf as follows (administrator permissions are needed for editing the file):

db_name = bitnami_odoo, newdatabase

After doing so, please restart the service odoo_background_worker:

$ sudo /opt/bitnami/ctlscript.sh restart odoo_background_worker
NOTE: The Odoo server configuration file and the default database name changed since the Odoo 10 version was released. If you are using a prior version, the Odoo server configuration file is at /opt/bitnami/apps/odoo/conf/openerp-server.conf and the default database name is bitnami_openerp.

How to configure domain-based database filters option?

Odoo can be configured to use sub-domain filtering so the users can run different Odoo databases on different sub-domains. This means you can have different Odoo websites/applications for different uses.

To configure this, follow the next steps:

Odoo 10.x or higher

  • Edit the /opt/bitnami/apps/odoo/conf/odoo-server.conf file and change these parameters:

      db_name = False
      dbfilter = ^%d$
      proxy_mode = True
    
  • Edit the /opt/bitnami/apps/odoo/scripts/odoo_background_worker.sh file and configure as shown below:

      SCHEDULER_START="$ODOO_HOME/bin/odoo-bin -c $ODOO_HOME/conf/odoo-server.conf --max-cron-thread 1 --db-filter=^%d$"
    
  • Edit the /opt/bitnami/apps/odoo/scripts/odoo_gevent.sh file and add the following values:

      GEVENT_START="$ODOO_HOME/bin/odoo-bin gevent -c $ODOO_HOME/conf/odoo-server.conf --max-cron-thread 0 --db-filter=^%d$"
    
  • Add the following lines at the bottom of the /opt/bitnami/apps/odoo/conf/httpd-app.conf file:

       <Proxy *>
         Order deny,allow
         Allow from all
       </Proxy>
       ProxyRequests Off
    
  • Restart all the services:

         $ sudo /opt/bitnami/ctlscript.sh restart
    

Odoo 9.x or earlier

  • Edit the /opt/bitnami/apps/odoo/conf/openerp-server.conf file and change these parameters:

      db_name = False
      dbfilter = ^%d$
      proxy_mode = True
    
  • Edit the /opt/bitnami/apps/odoo/scripts/openerp_background_worker.sh file and configure as shown below:

      SCHEDULER_START="$OPENERP_HOME/bin/openerp-server -c $OPENERP_HOME/conf/openerp-server.conf --max-cron-thread 1 --db-filter=^%d$"
    
  • Edit the /opt/bitnami/apps/odoo/scripts/openerp_gevent.sh file and add the following values:

      GEVENT_START="$OPENERP_HOME/bin/openerp-gevent -c $OPENERP_HOME/conf/openerp-server.conf --max-cron-thread 0 --db-filter=^%d$"
    
  • Add the following lines at the bottom of the /opt/bitnami/apps/odoo/conf/httpd-app.conf file:

       <Proxy *>
         Order deny,allow
         Allow from all
       </Proxy>
       ProxyRequests Off
    
  • Restart all the services:

     	 $ sudo /opt/bitnami/ctlscript.sh restart
    

How to upload files to the server with SFTP?

Although you can use any SFTP/SCP client to transfer files to your server, the link below explains how to configure FileZilla (Windows, Linux and Mac OS X), WinSCP (Windows) and Cyberduck (Mac OS X). It is required to use your server's private SSH key to configure the SFTP client properly. Choose your preferred application and follow the steps in the link below to connect to the server through SFTP.

How to upload files to the server

centurylink

Bitnami Documentation