Description

Wildfly is a lightweight, open source application server, formerly known as JBoss, that implements the latest enterprise Java standards.

First steps with the Bitnami WildFly Stack

Welcome to your new Bitnami application running on Google Cloud Platform! 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 Google Cloud Platform 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: manager

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

SSH username: bitnami

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

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.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

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.

How can I get started with WildFly?

To get started, we suggest the following steps:

Step 1. Access the management console.

The Wildfly management console provides an interface to manage the Wildfly server and deploy applications. To access it, refer to these instructions.

Step 2. Use Apache with Wildfly.

You can connect the Apache Web server with Wildfly through an HTTP proxy. To make them work together, enable the mod_proxy.so and mod_proxy_http.so modules in /opt/bitnami/apache2/conf/httpd.conf and then configure the ProxyPass directive in the /opt/bitnami/wildfly/conf/wildfly.conf file.

For more information, refer to these instructions.

How to access the WildFly server console?

For security reasons, the WildFly server console will be accessible only when using 127.0.0.1 as the hostname. To access the server console, it is necessary to create an SSH tunnel by forwarding port 9990 on the WildFly server to port 9990 on the local host.

An example of configuring the SSH tunnel using PuTTY on Windows is displayed below.

While the tunnel is active, you should be able to access the server console through the secure SSH tunnel you created, by browsing to http://127.0.0.1:9990/console.

Refer to the FAQ for platform-specific instructions to create the SSH tunnel.

How to upload files to the server with SFTP?

• If you are using the Bitnami Launchpad for Google Cloud Platform, obtain your server SSH key by following these steps:

  • Browse to the Bitnami Launchpad for Google Cloud Platform dashboard and sign in if required using your Bitnami account.
  • Select the "Virtual Machines" menu item.
  • Select your cloud server from the resulting list.
  • Download the SSH key for your server in PPK or PEM format. Note the server IP address on the same page.

• If you are using the GCP Marketplace, you will need to generate and add your SSH key manually using these instructions.

• Generate SSH key pair by executing the following commands:

	$ sudo su USERNAME
	$ ssh-keygen -t rsa -f ~/.ssh/my-ssh-key -C USERNAME

• Enter the passphrase twice. The SSH key pair will be generated and saved in /home/USERNAME/.ssh/my-ssh-key and /home/USERNAME/.ssh/my-ssh-key.pub.

Although you can use any SFTP/SCP client to transfer files to your server, this guide documents FileZilla (Windows, Linux and Mac OS X), WinSCP (Windows) and Cyberduck (Mac OS X).

Using an SSH Key

Once you have your server's SSH key, choose your preferred application and follow the steps below to connect to the server using SFTP.

FileZilla

Watch the following video to learn how to upload files to your Google Cloud server with SFTP using FileZilla. The example below shows a server launched using the Bitnami launchpad, but this video is applicable to those servers launched using the GCP Marketplace.

Or you can follow these steps:

• Download and install FileZilla.
• Launch FileZilla and use the "Edit -> Settings" command to bring up FileZilla's configuration settings.

• Within the "Connection -> SFTP" section, use the "Add keyfile" command to select the private key file for the server. FileZilla will use this private key to log in to the server.

  

• Use the "File -> Site Manager -> New Site" command to bring up the FileZilla Site Manager, where you can set up a connection to your server.
• Enter your server host name and specify bitnami as the user name.

• Select "SFTP" as the protocol and "Ask for password" as the logon type.

  

• Use the "Connect" button to connect to the server and begin an SFTP session. You might need to accept the server key, by clicking "Yes" or "OK" to proceed.

You should now be logged into the /home/bitnami directory on the server. You can now transfer files by dragging and dropping them from the local server window to the remote server window.

If you have problems accessing your server, get extra information by use the "Edit -> Settings -> Debug" menu to activate FileZilla's debug log.

WinSCP

Follow these steps:

• Download and install WinSCP.
• Launch WinSCP and in the "Session" panel, select "SCP" as the file protocol.

• Enter your server host name and specify bitnami as the user name.

  

• Click the "Advanced…" button and within the "SSH -> Authentication -> Authentication parameters" section, select the private key file for the server. WinSCP will use this private key to log in to the server.

  

• From the "Session" panel, use the "Login" button to connect to the server and begin an SCP session.

You should now be logged into the /home/bitnami directory on the server. You can now transfer files by dragging and dropping them from the local server window to the remote server window.

If you need to upload files to a location where the bitnami user doesn't have write permissions, you have two options:

• Once you have configured WinSCP as described above, click the "Advanced…" button and within the "Environment -> Shell" panel, select sudo su - as your shell. This will allow you to upload files using the administrator account.

  

• Upload the files to the /home/bitnami directory as usual. Then, connect via SSH and move the files to the desired location with the sudo command, as shown below:

   $ sudo mv /home/bitnami/uploaded-file /path/to/desired/location/
  

Cyberduck

Follow these steps:

• Select the "Open Connection" command and specify "SFTP" as the connection protocol.

  

• In the connection details panel, under the "More Options" section, enable the "Use Public Key Authentication" option and specify the path to the private key file for the server.

  

• Use the "Connect" button to connect to the server and begin an SFTP session.

You should now be logged into the /home/bitnami directory on the server. You can now transfer files by dragging and dropping them from the local server window to the remote server window.

How to connect instances hosted in separate virtual networks or VPCs?

The Google Cloud Platform makes it possible to connect instances hosted in separate Virtual Private Clouds (VPCs), even if those instances belong to different projects or are hosted in different regions. This feature, known as VPC Network Peering, can result in better security (as services do not need to be exposed on public IP addresses) and performance (due to use of private, rather than public, networks and IP addresses).

Learn more about VPC Network Peering.

How to find the MySQL database credentials?

• Database username: root.
• Database password: The same as the application password. Find out how to obtain application credentials.

What are the default access credentials for the server console?

Refer to the detail page for your cloud server for access credentials.

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.

$ mysql -u root -p

You will be prompted to enter the root user password. This is the same as the application password.

How is Apache server connected with WildFly?

Bitnami stacks include the Apache Web server. There are different ways to connect these two servers. One of this is connecting through an HTTP proxy.

The HTTP Connector element represents a Connector component that communicates with a web connector via the HTTP protocol. This is used to invisibly integrate Wildfly into an Apache installation and have Apache handle the static content of the web application and/or to utilize Apache's SSL processing.

To make them work together, enable the mod_proxy.so and mod_proxy_http.so modules in /opt/bitnami/apache2/conf/httpd.conf. Then, add the following lines to the /opt/bitnami/wildfly/conf/wildfly.conf file:

<Location /APPURL>
  ProxyPass http://localhost:8090/APPURL
</Location>

How to connect to WildFly from a different machine?

For security reasons, the WildFly ports in this solution cannot be accessed over a public IP address. To connect to WildFly from a different machine, you must open port 80, 443 for remote access. Refer to the FAQ for more information on this.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

How to reset the MariaDB root password?

If you don't remember your MariaDB root password, you can follow the steps below to reset it to a new value:

• Create a file in /home/bitnami/mysql-init with the content shown below (replace NEW_PASSWORD with the password you wish to use):

   UPDATE mysql.user SET Password=PASSWORD('NEW_PASSWORD') WHERE User='root';
   FLUSH PRIVILEGES;
  

• Stop the MariaDB server:

   $ sudo /opt/bitnami/ctlscript.sh stop mariadb
  

• Start MariaDB with the following command:

   $ sudo /opt/bitnami/mariadb/bin/mysqld_safe --defaults-file=/opt/bitnami/mariadb/my.cnf --pid-file=/opt/bitnami/mariadb/data/mysqld.pid --init-file=/home/bitnami/mysql-init 2> /dev/null &
  

• Restart the MariaDB server:

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

• Remove the init script

   $ rm /home/bitnami/mysql-init
  

How to change the MariaDB root password?

You can modify the MariaDB password using the following command at the shell prompt:

$ /opt/bitnami/mariadb/bin/mysqladmin -p -u root password NEW_PASSWORD

How to create an SSL certificate for Wildfly?

The commands required to create a self-signed certificate for Wildfly are shown below:

$ cd /opt/bitnami/wildfly/standalone/configuration
$ sudo keytool -genkey -alias server -keyalg RSA -validity 3650 -keysize 2048 -keystore server.keystore
$ sudo chown wildfly:wildfly ./server.keystore

How to enable SSL in Wildfly?

If your application includes lines similar to this in its web.xml file, you are forcing secure connections to Wildfly:

<user-data-constraint>
     <transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>

To achieve this, you must first enable SSL connections in Wildfly. Follow the steps below:

• Make sure that you have a SSL certificate for Wildfly stored in a keystore. Read more about this in the Wildfly documentation.

• Edit your Wildfly server configuration file at /opt/bitnami/wildfly/standalone/configuration/standalone.xml and add a new security realm as shown below:

   <security-realm name="ssl-realm">
    <server-identities>
     <ssl>
      <keystore path="server.keystore" relative-to="jboss.server.config.dir" keystore-password="keystore_password" alias="server" key-password="key_password" />
     </ssl>
    </server-identities>
   </security-realm>
  

• Modify the default listener in your Wildfly configuration file above:

   <!--<http-listener name="default" socket-binding="http" />-->
   <https-listener name="default" socket-binding="https" security-realm="ssl-realm"/>
  

• Restart the Wildfly server.

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

How to configure Apache with Wildfly using SSL?

Using the Bitnami Wildfly Stack, it is possible to have Apache working as a proxy server for Wildfly. If you have followed the steps to enable SSL directly in Wildfly, you must also configure Apache to use the Wildfly SSL port. To do this, follow the steps below:

• Modify the Apache configuration file for Wildfly at /opt/bitnami/wildfly/conf/wildfly.conf as shown below.

   SSLProxyEngine On
   SSLProxyVerify none
   SSLProxyCheckPeerCN off
   SSLProxyCheckPeerName off
   SSLProxyCheckPeerExpire off
  
   <Location />
     ProxyPass https://localhost:8443/
     ProxyPassReverse https://localhost:8443/
   </Location>
  

  The example above disables the ProxyVerify and ProxyCheck options because a dummy keystore is in use. If you have certificates provided by a Certificate Authority (CA), those options may be ignored.

• Restart the server to load the new configuration.

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

How can I run a command in the Bitnami WildFly Stack?

Log in to the server console as the bitnami user and run the command as usual. The required environment is automatically loaded for the bitnami user.

How to create a full backup of WildFly?

Backup

The Bitnami WildFly 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 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 debug errors?

The main Wildfly log file is created at /opt/bitnami/wildfly/standalone/log/wildfly.out.