Bitnami OroCRM for Huawei Enterprise Cloud

Transcription

1 Bitnami OroCRM for Huawei Enterprise Cloud Description OroCRM is a flexible open-source CRM application. OroCRM supports your business no matter the vertical. If you are a traditional B2B company, franchise, sell online only or are managing multiple sales channels, OroCRM will help you grow. First steps with the Bitnami OroCRM Stack Welcome to your new Bitnami application running on Huawei Enterprise Cloud! Here are a few questions (and answers!) you might need when first starting with your application. What is the administrator username set for me to log in to the application for the first time? Username: user What is the administrator password? To obtain the administrator password, click the "Remote Login" menu option next to the server name in the Huawei Cloud Server Console. This will launch a new browser window with an encrypted login session. The application password will be displayed on the login welcome screen. What SSH username should I use for secure shell access to my application? SSH username: root How to connect to the MySQL database? You can connect to the MySQL database from the same computer where it is installed with the mysql client tool.

2 mysql -u root -p You will be prompted to enter the root user password. This is the same as the application password. Find out how to obtain application credentials. How to debug errors in your database? The main log file is created at /opt/bitnami/mysql/data/mysqld.log on the MySQL database server host. 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 Updating the IP address or hostname

3 OroCRM requires updating the IP address/domain name if the machine IP address/domain name changes. The bnconfig tool also has an option which updates the IP address, called machine_hostname (use help to check if that option is available for your application). Note that this tool changes the URL to sudo /opt/bitnami/apps/orocrm/bnconfig --machine_hostname NEW_DOMAIN If you have configured your machine to use a static domain name or IP address, you should rename or remove the /opt/bitnami/apps/orocrm/bnconfig file. sudo mv /opt/bitnami/apps/orocrm/bnconfig /opt/bitnami/apps/orocrm/bncon fig.disabled NOTE: Be sure that your domain is propagated. Otherwise, this will not work. You can verify the new DNS record by using the Global DNS Propagation Checker and entering your domain name into the search field. You can also change your hostname by modifying it in your hosts file. Enter the new hostname using your preferred editor. sudo nano /etc/hosts Add a new line with the IP address and the new hostname. Here's an example. Remember to replace the IP-ADDRESS and DOMAIN placeholders with the correct IP address and domain name. IP-ADDRESS DOMAIN How to create a full backup of OroCRM? Backup The Bitnami OroCRM 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:

4 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.

5 How to configure outbound settings? You can configure the settings at /opt/bitnami/app/config/parameters.yml file of OroCRM installation. You have to configure it with your server provider. mailer_transport: smtp mailer_host: smtp.example.com mailer_user: user mailer_password: password To configure the application to use other third-party SMTP services for outgoing , such as SendGrid or Mandrill, refer to the FAQ. 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 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:

6 Use the table below to identify the correct locations for your certificate and configuration files. Variable Value Current application URL Example: or Apache /opt/bitnami/apache2/conf/bitnami/bitnami.conf configuration file Certificate file /opt/bitnami/apache2/conf/server.crt Certificate key file /opt/bitnami/apache2/conf/server.key CA certificate bundle file (if /opt/bitnami/apache2/conf/server-ca.crt present) 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 SSLCACertificateFile (Apache v2.4.8+) "/opt/bitnami/apache2/conf/server-ca.crt" Directive to include SSLCertificateChainFile (Apache < v2.4.8) "/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*

7 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 create an SSL certificate? You can create your own SSL certificate with the OpenSSL binary. 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). Create your private key (if you haven't created it already): 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 -o ut /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/apach e2/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 -o ut 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

8 starts. Regenerate the key without password protection from this file as follows: sudo openssl rsa -in privkey.pem -out /opt/bitnami/apache2/conf/se rver.key Find more information about certificates at How to force HTTPS redirection? Add the following to the top of the /opt/bitnami/apps/orocrm/conf/httpd-prefix.conf file: RewriteEngine On RewriteCond %{HTTPS}!=on RewriteRule ^/(.*) [R,L] After modifying the Apache configuration files, 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 modify PHP settings?

9 The PHP configuration file allows you to configure the modules enabled, the settings or the size of the upload files. It is located at /opt/bitnami/php/etc/php.ini. After modifying the PHP configuration file, restart both Apache and PHP-FPM for the changes to take effect: sudo /opt/bitnami/ctlscript.sh restart apache sudo /opt/bitnami/ctlscript.sh restart php-fpm For example, to modify the default upload limit for PHP, update the PHP configuration file following these instructions. How to modify the allowed limit for uploaded files? Modify the following options in the /opt/bitnami/php/etc/php.ini file to increase the allowed size for uploads: ; Maximum size of POST data that PHP will accept. post_max_size = 16M ; Maximum allowed size for uploaded files. upload_max_filesize = 16M Restart PHP-FPM and Apache for the changes to take effect. sudo /opt/bitnami/ctlscript.sh restart apache sudo /opt/bitnami/ctlscript.sh restart php-fpm How to access phpmyadmin? For security reasons, phpmyadmin is accessible only when using as the hostname. To access it from a remote system, you must create an SSH tunnel that routes requests to the Apache Web server from This implies that you must be able to connect to your server over SSH in order to access these applications remotely. IMPORTANT: Before following the steps below, ensure that your Apache and

10 MySQL servers are running. NOTE: The steps below suggest using port 8888 for the SSH tunnel. If this port is already in use by another application on your local machine, replace it with any other port number greater than 1024 and modify the steps below accordingly. Similarly, if you have enabled Varnish, your stack's Apache Web server might be running on port 81. In this case, modify the steps below to use port 81 instead of port 80 for the tunnel endpoint. Windows To access the application using your Web browser, create an SSH tunnel, as described below. Download PuTTY and make sure you can log in to the server console with it following the instructions in the FAQ. Once you have confirmed you are able to log in successfully, log back out. Reconnect to the server using PuTTY, this time adapting the steps to include an additional SSH tunnel. When configuring the new SSH session in PuTTY, additionally navigate to the "Connection -> SSH -> Tunnels" section and create a secure tunnel by forwarding port 80 on the server to port 8888 on the local host ( or localhost). Click the "Add" button to add the secure tunnel configuration to the session. Here is an example:

11 Go back to the "Session" section and save your changes by clicking the "Save" button. Click the "Open" button to open an SSH session to the server. The SSH session will now include a secure SSH tunnel between the two specified ports. While the tunnel is active, you should be able to access the phpmyadmin console through the secure SSH tunnel you created, by browsing to To log in, use username root for MySQL and the application password from the detail page for your cloud server. If you are unable to access phpmyadmin, verify that the SSH tunnel was created by checking the PuTTY event log (accessible via the "Event Log" menu):

12 Linux and Mac OS X To access the application using your Web browser, create an SSH tunnel, as described below. Open a new terminal window on your local system (for example, using "Finder -> Applications -> Utilities -> Terminal" in Mac OS X or the Dash in Ubuntu). Make sure you can log in to the server console following the instructions in the FAQ. Once you have confirmed you are able to log in successfully, log back out. Run the following command to configure the SSH tunnel. Remember to replace SERVER-IP with the public IP address or hostname of your server. Enter your SSH password when prompted. ssh -N -L 8888: :80 bitnami@server-ip If you are using a private key to connect to the server, use the following command instead, remembering to replace KEYFILE with the path to your private key and SERVER-IP with the public IP address or hostname of your server: ssh -N -L 8888: :80 -i KEYFILE bitnami@server-ip NOTE: If successful, the above commands will create an SSH tunnel but will not display any output on the server console. While the tunnel is active, you should be able to access the phpmyadmin console through the secure SSH tunnel you created, by browsing to To log in, use username root for MySQL and the application password from the detail page for your cloud server.

13 How to clear the OroCRM cache? After making any changes to OroCRM, it is highly recommended to clear the cache. Follow these steps: cd apps/orocrm/htdocs php app/console cache:clear -env prod It is important to apply read, write and execute permissions (recursive) to the cache/ folder after clearing the cache (if running with root privileges): sudo chmod -R 777 app/cache How to configure cron jobs to execute automatically? Cron jobs allow OroCRM to execute tasks that should be executed at fixed times (for example, sending to customers or generating reports). Usually, these tasks wouldn't be performed by visiting a particular URL using your browser. Instead, you'll configure your operating system to execute some script which performs the desired tasks. Follow these steps: Run the following command to edit the crontab file: sudo crontab -e Add the following lines to the file. The jobs will be executed the first minute of every hour. You can modify the timing if you wish: *1/ * * * * /opt/bitnami/php/php /opt/bitnami/orocrm/htdocs/app/c onsole oro:cron --env prod >> /dev/null Save the file. How to execute jobs using OroCRM's dashboard?

14 It is possible to execute queued jobs manually using OroCRM's dashboard, instead of configuring this through the crontab. Follow these steps: Log in to the OroCRM dashboard. Browse to the "System -> Job Queue" tab. Click the red "Run Daemon" button to start the queued jobs. NOTE: It could take several minutes for the jobs to finish. They will run in the background so you can browse to a new page if you wish. How to increase the memory limit of OroCRM? Change the memory limit only for the console file In order to change the memory_limit value for the console file, you should modify the /opt/bitnami/apps/orocrm/htdocs/app/console file and edit this line to your custom value: ini_set('memory_limit', '1024M'); Change the memory limit globally In order to change the memory_limit value globally for OroCRM, you should modify the */opt/bitnami/apps/orocrm/htdocs/app/console *file and remove this line:

15 ini_set('memory_limit','800m'); Then, set the custom memory_limit value as below. Note that this will apply the new memory_limit value to all applications in the /opt/bitnami/apps/ directory. To modify the assigned memory value to PHP, you will need to modify the memory_limit value in the /opt/bitnami/php/etc/php.ini file: memory_limit = 128M Also, note that your application might use.htaccess and Apache configuration files to configure the PHP memory limit. To check this, run these commands: cd /opt/bitnami/apps grep -R "php_value memory_limit". cd /opt/bitnami/php grep -R "memory_limit". cd /opt/bitnami/apache grep -R "php_value memory_limit". Remember to restart your server to reload the configuration.