Bitnami Subversion for Huawei Enterprise Cloud

Transcription

1 Bitnami Subversion for Huawei Enterprise Cloud Description Subversion enables globally distributed software development teams to efficiently version and share source code with low administrative overhead. First steps with the Bitnami Subversion 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:

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 Subversion? Backup The Bitnami Subversion 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:

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

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

5 file to include the following line below the SSLCertificateKeyFile directive. Choose the correct directive based on your scenario and Apache version: Variable Apache configuration file Directive to include (Apache v2.4.8+) Directive to include (Apache < v2.4.8) Value /opt/bitnami/apache2/conf/bitnami/bitnami.conf SSLCACertificateFile "/opt/bitnami/apache2/conf/server-ca.crt" 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 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

6 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 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/subversion/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.

7 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 start with Subversion? By default, Bitnami provides a Subversion repository and Apache server to access it using a Web browser. The default configuration uses svnserver but other methods (like SSH) can also be used to access the repository. NOTE: The default Subversion port is 3690 and it is necessary to open this port in the server firewall for remote access. Refer to the FAQ for more information. Get started with Subversion as follows: Log in using SSH and configure repository access. The repository configuration file is /opt/bitnami/repository/conf/svnserve.conf. The variables anon-access and auth-access can be set to the values none, read, or write. Setting the value to none prohibits both reading and writing; read allows read-only access to the repository, and write allows complete read/write access to the repository. For example, uncomment these lines for a reasonable starting configuration: [general] anon-access = read

8 auth-access = write password-db = passwd Edit the passwd file in the same directory to manage Subversion users. For example, uncomment these lines to create two subversion users: harry and sally. [users] harry = harryssecret sally = sallyssecret Restart the Subversion server to load the changes. sudo /opt/bitnami/ctlscript.sh restart subversion Import a project directory to Subversion from your local machine and check the files in your browser: svn import /path/to/project/ svn://server-ip/repository/ -m "First import" How to create a Subversion repository? Connect to your server via SSH and execute the following commands to create the repositories directory at /opt/bitnami/repositories and then a new Subversion repository named myapp: sudo mkdir /opt/bitnami/repositories sudo svnadmin create /opt/bitnami/repositories/myapp sudo chown -R bitnami:bitnami /opt/bitnami/repositories How to configure your Subversion repository though SSH? To create a repository that allows access remotely over SSH, follow these steps:

9 Connect to your server via SSH and execute the following commands to create the repositories directory at /opt/bitnami/repositories and then a new Subversion repository named myapp: sudo mkdir /opt/bitnami/repositories sudo svnadmin create /opt/bitnami/repositories/myapp sudo chown -R bitnami:bitnami /opt/bitnami/repositories Assign your repository to a Redmine project. In Redmine, navigate to the project "Settings -> Repository" menu and add the following value in the "URL" field (username and password are not necessary): file:///opt/bitnami/repositories/myapp Check if you have Subversion binaries in the system path even in the non-interactive SSH session. Execute the following command: ssh -l bitnami -i KEYFILE SERVER-IP svn Remember to replace KEYFILE in the previous commands with the path to your private key file, and SERVER-IP with the public IP address or hostname of your server. If you receive a "Command not found" error, update the /home/bitnami/.bashrc file and move all Bitnami path configuration from the bottom of this file to the top, above this line [ -z "$PS1" ] && return Check out the repository now and start adding and committing new files. The repository should be available remotely via the following URL. The Subversion client should be configured to use the username bitnami and corresponding SSH key: svn+ssh://xyz.bitnamiapp.com/opt/bitnami/repositories/myapp Remember to replace xyz.bitnamiapp.com with the public IP address or hostname of your server. To add a file to your repository, execute the following commands on your local host. Remember to replace bitnami-hosting.pem in the previous commands with the path to your private key file, and

10 xyz.bitnamiapp.com with the public IP address or hostname of your server. export SVN_SSH="ssh -l bitnami -i bitnami-hosting.pem" svn checkout svn+ssh://xyz.bitnamiapp.com/opt/bitnami/repositorie s/myapp cd myapp echo "This is a simple test" > Readme.txt svn add Readme.txt svn commit -m "Adding simple readme file, closes #1" How to see the Subversion repository from the web browser? To browse the Subversion repository using a Web browser, follow the steps below: Update the Apache configuration file at /opt/bitnami/apache2/conf/httpd.conf to load the following modules: LoadModule dav_module modules/mod_dav.so LoadModule dav_fs_module modules/mod_dav_fs.so LoadModule dav_svn_module modules/mod_dav_svn.so LoadModule authz_svn_module modules/mod_authz_svn.so In the same file, verify the endpoint URL and path for your Subversion repository. For example, the directives below will let you view the default repository at /opt/bitnami/repository by browsing to <Location /subversion> DAV svn SVNPath "/opt/bitnami/repository" </Location> Restart Apache:

11 sudo /opt/bitnami/ctlscript.sh restart apache You should now be able to checkout the repository using a tool like TortoiseSVN. Simply enter the URL as as the repository checkout URL in the TortoiseSVN interface, as shown below. Enabling access over HTTPS You can also access the repository over HTTPS if you have configured the Apache SSL certificate for your server. The following error can occur if the hostname reported by the server does not match the hostname in the SSL certificate. Make sure your server configuration uses the correct ServerName value. svn: OPTIONS of ' SSL negotiation faile d: SSL error code -1/1/ ( Enabling commits over HTTP(S)? For security reasons, the default configuration does not allow users to commit changes to the repositories over HTTP or HTTPS. To permit this, change the permissions of your repository directory so that the Apache user is able to write to it.

12 Run the following command, assuming your repository is located at the default location of /opt/bitnami/repository: sudo chown -R daemon:subversion /opt/bitnami/repository IMPORTANT: Making this change will allow any user to commit changes to your repository. To avoid unauthorized commits and possible data loss, configure basic authentication for your repository as discussed in the next section You should now be able to commit changes to the repository using a tool like TortoiseSVN, as shown below.

13 How to configure the repository URL? If no prefix is set in the Subversion scripts, specify the full path to the repository - for instance, svn://server-ip/home/user/repository. In case this is not possible, add the repository path to the Subversion control script. Edit the file /opt/bitnami/subversion/scripts/ctl.sh and add the path as follows: -d --listen-port= root=/path/to/repository Restart the Subversion server. How to configure basic authentication for your repository? Once your repository is accessible over HTTP(s), it is recommended that you protect it from unauthorized access by configuring authentication for different users. To do this, follow the steps below: Update the Apache configuration file at /opt/bitnami/apache2/conf/httpd.conf and add the highlighted directives below. <Location /subversion> DAV svn SVNPath "/opt/bitnami/repository"

14 AuthType Basic AuthName "Subversion repository" AuthUserFile /opt/bitnami/repository/users require valid-user </Location> With this configuration, repository access is only available to those users listed in the /opt/bitnami/repository/users file and they will need to authenticate themselves before gaining access. Note that you should update the path to the file based on the actual location of your repository. Create the /opt/bitnami/repository/users file and add a user account named myuser to it using the following command. You will be prompted to enter a password for the user account. Note that you should update the path to the file based on the actual location of your repository. sudo /opt/bitnami/apache2/bin/htpasswd -c /opt/bitnami/repository /users myuser Repeat this step to add more users, omitting the -c argument on subsequent invocations. For example: sudo /opt/bitnami/apache2/bin/htpasswd /opt/bitnami/repository/us ers myotheruser Restart the Apache server. sudo /opt/bitnami/ctlscript.sh restart apache If you now attempt to browse to the repository or access it using TortoiseSVN, you will be prompted for a user name and password, as shown below:

15 Anonymous browsing If you want your repository readable but not editable by any other user, perform the steps above but changing the line require valid-user to <LimitExcept GET PROPFIND OPTIONS REPORT> require valid-user </LimitExcept> HTTPS access only If you only want to only allow access through HTTPS, not HTTP, you should add SSLRequireSSL to the directives described above:... AuthName "Subversion repository" AuthUserFile /opt/bitnami/repository/users require valid-user SSLRequireSSL </Location>

16 How to enable post-commit notifications via for Subversion? To configure a Subversion repository to send s via SMTP with the commit log, follow these steps: Download the latest source code from Subversion and copy the hooks directory into the /opt/bitnami/subversion directory: wget z tar -xzvf subversion tar.gz sudo cp -r subversion-1.8.9/tools/hook-scripts /opt/bitnami/subver sion/hooks Copy the example mailer.conf file: sudo cp /opt/bitnami/subversion/hooks/mailer/mailer.conf.example /opt/bitnami/subversion/hooks/mailer/mailer.conf Configure the SMTP mail settings in the mailer.conf file. Here is an example for a Gmail account: [General] smtp_hostname = smtp.gmail.com:587 smtp_username = your_gmail_account smtp_password = your_password smtp_use_ssl = true... [defaults] from_addr = mail@example.com # The default To: addresses for message. One or more addresses,

17 # separated by whitespace (no commas). # NOTE: If you want to use a different character for separating t he # addresses put it in front of the addresses included in squ are # brackets '[ ]'. to_addr = mail@example.com # If this is set, then a Reply-To: will be inserted into the mess age. reply_to = mail@example.com To use a Gmail account or an SSL connection for SMTP settings, modify the SMTPOutput class in mailer.py with a patch in order to use the added smtp_use_ssl setting. This patch was submitted by Alexey -278,6 def finish(self): server = smtplib.smtp(self.cfg.general.smtp_hostname) + # asadomov: add ssl configuration (e.g. for gmail smtp server) + if self.cfg.is_set('general.smtp_use_ssl') and self.cfg.gene ral.smtp_use_ssl.lower() == "true": + server.ehlo() + server.starttls() + server.ehlo() + if self.cfg.is_set('general.smtp_username'): Configure your post-commit hook script to use the mailer.py and mailer.conf files. The location of your post-commit script depends on the location of your repository. Edit the /opt/bitnami/repositories/repository-name/hooks/post-commit.tmpl file and replace the last line with the following one:

18 /opt/bitnami/python/bin/python /opt/bitnami/subversion/hooks/mai ler/mailer.py commit "$REPOS" "$REV" /opt/bitnami/subversion/hooks /mailer/mailer.conf In case the /opt/bitnami/python directory does not exist, use the system's Python binary, usually at /usr/bin/python. Enable the post-commit hook by renaming the post-commit script and removing the.tmpl extension: sudo mv /opt/bitnami/repositories/your_repo/hooks/post-commit.tmp l /opt/bitnami/repositories/your_repo/hooks/post-commit To test it, change a file and commit the changes. In case of an error, the error message will be displayed after the commit.