Bitnami Node.js for Huawei Enterprise Cloud

Transcription

1 Bitnami Node.js for Huawei Enterprise Cloud Description Node.js is a platform built on Chrome's JavaScript runtime for easily building fast, scalable network applications. It uses an event-driven, non-blocking I/O model that makes it lightweight and efficient. How can I get started with Node.js? To get started, we suggest the following steps: Step 1. Create a new Express project. Install Express by executing the commands below: sudo npm -g install express sudo npm -g install express-generator Then, create a skeleton project and install dependencies: mkdir -p projects cd projects express sample-application For more information, refer to these instructions. Step 2. Deploy your Node.js application with Express. To start your application server, you just have to execute the following commands, inside your application directory: npm install npm start If you are using a recent Express version (greater than 4.0), you should use the following command instead:./bin/www

2 For more information, refer to these instructions. Step 3. Install modules with npm. To install modules locally, you just have to execute this command: npm install PACKAGE To install modules globally, use: npm -g install PACKAGE We recommend installing packages in both local and global modes, so that you can share installed commands and still protect the dependencies of your project. For more information, refer to these instructions. 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

3 How can I run a command in the Bitnami Node.js 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 upload files to the server with SFTP? NOTE: Bitnami applications can be found in /opt/bitnami/apps. When uploading files via SFTP, you must have the server's IP address, username and password or, if you chose to deploy the server with an SSH key instead of a password, you must have the server username and corresponding SSH private key in.ppk format (for Windows) or in.pem format (for Linux and Mac OS X). To obtain the IP address for your server, follow these steps: Log in to the Huawei Cloud Server Console. Navigate to the "Computing -> Elastic Cloud Server" section. Note the public IP address for the server you wish to connect to. Once you have confirmed that you have the IP address and correct SSH credentials for your server, follow the instructions below depending on the platform you wish to use. 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

4 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 IMPORTANT: To use FileZilla, your server private key should be in PPK format. 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.

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

6 WinSCP IMPORTANT: To use WinSCP, your server private key should be in PPK format. Follow these steps: Download and install WinSCP. Launch WinSCP and in the "Session" panel, select "SFTP" as the file protocol.

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

8 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 IMPORTANT: To use Cyberduck, your server private key should be in PEM

9 format. 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

10 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. Using a Password Once you have your server's SSH credentials, choose your preferred application and follow the steps below to connect to the server using SFTP. FileZilla Follow these steps: Download and install FileZilla. Launch FileZilla and 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. Select "SFTP" as the protocol and "Ask for password" as the logon type. Use bitnami as the server username and the password generated

11 during the server deployment process. 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.

12 WinSCP Follow these steps: Download and install WinSCP. Launch WinSCP and in the "Session" panel, select "SFTP" as the file protocol.

13 Enter your server host name and set bitnami as the server username. From the "Session" panel, use the "Login" button to connect to the server and begin an SCP session. Enter the password when prompted. 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. Cyberduck Follow these steps:

14 Select the "Open Connection" command and specify "SFTP" as the connection protocol. In the connection details panel, enter the server IP address, bitnami as the username, and the password generated during the deployment

15 process 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 create a project using Express? Express is a high-performance Web development framework for Node.js inspired by Sinatra. Installing it is as simple as executing the commands below: sudo npm -g install express sudo npm -g install express-generator

16 Create a skeleton project by executing these commands. This will produce a new application in the projects/sample-application directory: mkdir -p projects cd projects express sample-application Install dependencies using npm: cd sample-application npm install This will download and install the required dependencies into a node_modules directory under your project folder. How to start the Express web application? To start your application server, you just have to execute the following command, inside your application directory: node app.js If you are using a recent Express version (greater than 4.0), you should use the following command instead:./bin/www Port 3000 is the default port used by Express when creating the template. This means that you may receive an error similar to the below when starting the server: Error: listen EADDRINUSE at errnoexception (net.js:670:11) at Array.0 (net.js:771:26) at EventEmitter._tickCallback (node.js:190:38) This means that the port is already in use. Edit the app.js script and change the line containing app.listen() to use a different port number, as below. Then, start the application again.

17 app.listen(4000, function(){ How to install Node.js applications? NOTE: To avoid a conflict between two or more Node.js applications attempting to use the same port, modify the application settings as needed to use a different port for each application. To install a Node.js application, first ensure that all dependences are satisfied. Many applications will require Node.js and MongoDB, but others may require Redis or MySQL. To check available services, run this command: sudo /opt/bitnami/ctlscript.sh status To install an application in the example/ directory, follow these steps: Create the directory: sudo mkdir /opt/bitnami/apps/example Move the application files to that directory and follow the official installation steps. How to install modules? Node.js comes with the npm package manager. Using it, you can install, uninstall and search for Node.js modules. npm installs modules in two different scopes: local and global. Local Installation The local installation is recommended, as the size of the packages is usually small. It installs the packages in a node_modules subdirectory of the current working directory, usually a project folder. This ensures all the required dependencies are installed and won't break when installing other packages in a different project or locally. To install modules locally, you just have to execute this command: npm install PACKAGE For example, to install MySQL, you would execute:

18 npm install mysql Global Installation In other cases (typically when the module installs a command line tool), it is more convenient to install the packages globally. In these cases, the command varies slightly: sudo npm -g install PACKAGE For example, to install Express, you would execute: sudo npm -g install express This will make the Express command-line available in all projects. We recommend installing packages in both local and global modes, so that you can share installed commands and still protect the dependencies of your project. How to list the installed modules? To list the modules installed locally in a project, enter the project directory and execute the npm list command, as shown in the example below. cd sample-application npm list application-name@0.0.1 /home/bitnami/projects/sample-application +-- express@ connect@ formidable@ mime@ mkdirp@ qs@ jade@ commander@0.5.2

19 +-- You can also list the globally installed packages by entering the project directory and executing the npm -g list command, as shown below: cd sample-application npm -g list /opt/bitnami/nodejs/lib How to upgrade npm?

20 You can upgrade npm to the latest version with the following command: npm -g install npm How to connect your Node.js application to an Oracle Database? In order to connect your Node.js application to an Oracle Database, you need to install the following packages. libaio Oracle Instant Client (and SDK) oracledb Node.js module Step 1: Install libaio Execute the following command: sudo apt-get install libaio1 Step 2: Install Oracle Instant Client and Oracle Instant Client SDK Download both instantclient-basic-linux.x64.zip and instantclient-sdk-linux.x64.zip. The version will depend on the Oracle Database you have running. For instance, for Oracle Database 12c you would download instantclient-basic-linux.x zip and instantclient-sdk-linux.x zip (we will use them in the rest of the examples). Uncompress instantclient-basic-linux.x64.zip by executing the following command: unzip instantclient-basic-linux.x zip Copy the extracted contents to /opt/bitnami/common/lib: sudo cp -r instantclient_12/* /opt/bitnami/common/lib Execute the following command:

21 sudo ln -s /opt/bitnami/common/lib/libclntsh.so.12.1 /opt/bitnami/ common/lib/libclntsh.so Extract instantclient-sdk-linux.x zip: unzip instantclient-sdk-linux.x zip Copy the contents of the sdk subfolder to /opt/bitnami/common/include: sudo cp -r instantclient_12/sdk/include/* /opt/bitnami/common/incl ude Step 3: Install OracleDB Node.js module Before installing, set the following environment variables: export OCI_LIB_DIR=/opt/bitnami/common/lib export OCI_INC_DIR=/opt/bitnami/common/include In your Node.js application folder, execute the following command: npm install oracledb Step 4: Test the connection In order to test that the plugin was installed correctly, execute one of the examples detailed in the OracleDB Node.js module documentation. Download this example from the OracleDB Node.js module website. In the same folder where connect.js was downloaded, create the file dbconfig.js with the following contents (remembering to replace the DATABASE_USER, DATABASE_PASSWORD and DATABASE_CONNECTION_STRING placeholders with the correct values): module.exports = { user : "DATABASE_USER", password : "DATABASE_PASSWORD", connectstring : "DATABASE_CONNECTION_STRING"

22 }; For example: module.exports = { user password : "SYSTEM", : "mypassword", ternal" }; connectstring : " :1521/PDB1.oracleuser.oraclecloud.in Run the testing program: node example.js If everything was correct, you should see the message "Connection was successful!" How to create a custom Node.js application? Many users run a Bitnami stack as a development environment for their own projects (as opposed to running third-party applications). To create a custom Node.js application from scratch, follow the steps below. These steps assume that your application will live in the /opt/bitnami/apps/myapp/ directory: Run the following commands to create the directories: sudo mkdir -p /opt/bitnami/apps/myapp sudo mkdir /opt/bitnami/apps/myapp/conf sudo mkdir /opt/bitnami/apps/myapp/htdocs Create and edit the /opt/bitnami/apps/myapp/conf/httpd-prefix.conf file and add the line below to it: Include "/opt/bitnami/apps/myapp/conf/httpd-app.conf" Create and edit the /opt/bitnami/apps/myapp/conf/httpd-app.conf file and add the content below to it. This is the main configuration file for your application, so modify it further depending on your application's requirements.

23 ProxyPass / ProxyPassReverse / NOTE: 3000 is the default port for the Express server. If you have customized your application to use a different port, change it here as well. Once you have created the files and directories above, add the following line to the end of the main Apache configuration file at /opt/bitnami/apache2/conf/bitnami/bitnami-apps-prefix.conf, as shown below: Include "/opt/bitnami/apps/myapp/conf/httpd-prefix.conf" Restart the Apache server: sudo /opt/bitnami/ctlscript.sh restart apache Start the Express server: cd /opt/bitnami/apps/myapp/htdocs./bin/www Although your application is now available, you may not be able to access it immediately. This is because the Express server runs on port 3000 by default, and Bitnami stacks on some platforms have this port closed for security reasons. To access the application, you will need to create an SSH tunnel to the port.