Bitnami DokuWiki for Huawei Enterprise Cloud

Transcription

1 Bitnami DokuWiki for Huawei Enterprise Cloud Description DokuWiki is a standards-compliant, simple to use wiki optimized for creating documentation. It is targeted at developer teams, workgroups, and small companies. All data is stored in plain text files, so no database is required. First steps with the Bitnami DokuWiki 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 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: 华为保密信息, 未经授权禁止扩散第 1 页, 共 12 页

2 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 create a full backup of DokuWiki? Backup The Bitnami DokuWiki 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: 华为保密信息, 未经授权禁止扩散第 2 页, 共 12 页

3 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 configure outbound settings? DokuWiki requires the SwiftMail plugin to send s through SMTP. Bitnami Dokuwiki already ships this plugin so you only have to configure it 华为保密信息, 未经授权禁止扩散第 3 页, 共 12 页

4 Edit the /opt/bitnami/apps/dokuwiki/htdocs/conf/local.php file and add the following at the end of the file. Replace the ADDRESS placeholder with a valid address. $conf['mailfrom'] = 'ADDRESS'; Edit the following options in the /opt/bitnami/apps/dokuwiki/htdocs/lib/plugins/swiftmail/conf/default.php file: $conf['smtp_host'] = ' '; $conf['smtp_port'] = ' '; $conf['smtp_ssl'] = ' '; $conf['auth_user'] = ' '; $conf['auth_pass'] = ' '; If you are configuring the application to send s through Gmail, you should use the following options. Replace USERNAME and PASSWORD with your Gmail account username and password respectively. $conf['smtp_host'] = 'smtp.gmail.com'; $conf['smtp_port'] = '465'; $conf['smtp_ssl'] = '4'; $conf['auth_user'] = 'USERNAME@gmail.com'; $conf['auth_pass'] = 'PASSWORD'; To configure the application to use other third-party SMTP services for outgoing , such as SendGrid or Mandrill, refer to the FAQ. Troubleshooting Gmail SMTP issues If you are using Gmail as the outbound server and you are not able to send 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 华为保密信息, 未经授权禁止扩散第 4 页, 共 12 页

5 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 clients, such as Outlook and Thunderbird, and should not be considered unsafe. Select the "Turn on" option. 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: 华为保密信息, 未经授权禁止扩散第 5 页, 共 12 页

6 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. 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: Use the table below to identify the correct locations for your certificate and configuration files 华为保密信息, 未经授权禁止扩散第 6 页, 共 12 页

7 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 /opt/bitnami/apache2/conf/bitnami/bitnami.conf configuration file 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* Open port 443 in the server firewall. Refer to the FAQ for more information. Restart the Apache server 华为保密信息, 未经授权禁止扩散第 7 页, 共 12 页

8 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 -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/b itnami/apache2/conf/server.crt -req -signkey /opt/bitnami/apache2/co nf/server.key -days 365 Back up your private key in a safe location after generating a passwordprotected 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: 华为保密信息, 未经授权禁止扩散第 8 页, 共 12 页

9 sudo openssl rsa -in privkey.pem -out /opt/bitnami/apache2/conf/s erver.key Find more information about certificates at How to force HTTPS redirection? Add the following to the top of the /opt/bitnami/apps/dokuwiki/conf/httpdprefix.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 页, 共 12 页

10 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 upgrade DokuWiki? Since DokuWiki d-0, Bitnami includes the DokuWiki Upgrades plugin by default. If you have installed this version or above we recommend to use the plugin's process. Otherwise, if you have a version of DokuWiki lower than d, you have to use the manual upgrade 华为保密信息, 未经授权禁止扩散第 10 页, 共 12 页

11 How to upgrade DokuWiki using the Upgrade plugin? This is the easiest and recommended way to upgrade DokuWiki. Log in to DokuWiki using the administrator credentials and access to your administrator panel. In the "Additional Plugins" section, click the "Wiki Upgrade" link and continue with the upgrade wizard. At the end of the process, the latest version of DokuWiki will be installed. How to manually upgrade DokuWiki? 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. There are two different ways to upgrade your application. If you want to upgrade the application and all Stack components like PHP, Ruby, MySQL, Apache, migrate the DokuWiki data to a new instance. In this case only copy the following folders into the /opt/bitnami/apps/dokuwiki folder: data, doku_conf and htdocs/lib/plugins. In case you only want to upgrade the application code without modifying any other Stack components, follow the official DokuWiki guide to upgrade the application: Download the new version with wget and the link from the DokuWiki downloads page: wget 59fc3d1b61d2fd98a.tgz Uncompress the files and overwrite the previous files: tar -xzvf dokuwiki-24224dc7d432e5659fc3d1b61d2fd98a.tgz -C /op t/bitnami/apps/dokuwiki/htdocs/ --strip-components 1 Check the new version is running in the Admin panel. Note that DokuWiki might continue to show the update message. To avoid this, wait one day to fix it or just "touch" the doku.php file: 华为保密信息, 未经授权禁止扩散第 11 页, 共 12 页

12 touch /opt/bitnami/apps/dokuwiki/htdocs/doku.php 华为保密信息, 未经授权禁止扩散第 12 页, 共 12 页