Deploying in Production
Follow the instructions below to deploy WSO2 Dashboard Server in production.
Apply the following changes on a fresh WSO2 Dashboard Server instance. Do not start the WSO2 Dashboard Server until the configurations are finalized.
Step 1 - Change the default key store
- Open the
<DS_HOME>/repository/conf/carbon.xml
file. The private key is used for the HTTPS channel and for the token issuer to sign the issued tokens.
Update the following section of thecarbon.xml
to match your private key information.The private key must be available in a keystore of the "JKS" or "PKCS12" type. For more information, see KeyStore and Creating New Keystores.
<!-- Security configurations --> <Security> <!-- KeyStore which will be used for encrypting/decrypting passwords and other sensitive information. --> <KeyStore> <!-- Keystore file location--> <Location>${carbon.home}/repository/resources/security/wso2carbon.jks</Location> <!-- Keystore type (JKS/PKCS12 etc.)--> <Type>JKS</Type> <!-- Keystore password--> <Password>wso2carbon</Password> <!-- Private Key alias--> <KeyAlias>wso2carbon</KeyAlias> <!-- Private Key password--> <KeyPassword>wso2carbon</KeyPassword> </KeyStore> <!-- The directory under which all other KeyStore files will be stored --> <KeyStoresDir>${carbon.home}/repository/resources/security</KeyStoresDir> </Security>
Step 2 - Change the hostname
- Open the
<DS_HOME>/repository/conf/carbon.xml
file. Change the dashboard's hostname to match the "Common Name" of the certificate, which includes the private key.
For example, if the common name isds.wso2.com
, update the configuration as follows:Example<!-- Host name or IP address of the machine hosting this server e.g. www.wso2.org, 192.168.1.10 This is will become part of the End Point Reference of the services deployed on this server instance. --> <HostName>ds.wso2.com</HostName> <!-- Host name to be used for the Carbon management console --> <MgtHostName>ds.wso2.com</MgtHostName> <!-- The URL of the back end server. This is where the admin services are hosted and will be used by the clients in the front end server. This is required only for the Front-end server. This is used when seperating BE server from FE server --> <ServerURL>local:/${carbon.context}/services/</ServerURL>
Step 3 - Configure the HTTP/HTTPS ports
Open the
<DS_HOME>/repository/conf/tomcat/catalina-server.xml
file and configure the HTTP and HTTPS ports in the<connector>
elements.Example<Connector protocol="org.apache.coyote.http11.Http11NioProtocol" port="9763" ... /> <Connector protocol="org.apache.coyote.http11.Http11NioProtocol" port="9443" scheme="https" ... />