tencent cloud


Quickly Deploying Koa Framework

Last updated: 2022-07-22 15:09:26

    The SLS framework deployment scheme has been upgraded. You can use an SCF HTTP-triggered function to quickly deploy your Koa service to the cloud.


    What are the differences between SLS console deployment and direct function deployment?
    Both SLS console deployment and function deployment can be based on HTTP-triggered functions, and quick deployment is usually used for web frameworks.

    • If you only need to develop code logic and do not need to create additional resources, you can perform quick deployment through the Serverless console.
    • If you need to create more capabilities or resources, such as automatic creation of layer hosting dependencies, quick implementation of static resource isolation, and support for direct code repository pulling, in addition to code deployment, you can use the SLS console to create web applications.



    Template deployment - deploying Koa sample code

    1. Log in to the SLS console.
    2. Choose Create Application and select Web Application > Koa Framework.
    3. Click Next and complete basic configuration.
    4. Select Sample Code as the upload mode and click Complete. The application deployment starts.
    5. After the application deployment is completed, you can view the basic information of the sample application on the application details page. In addition, you can use access the deployed Koa project at the access path URL generated by API Gateway.

    Custom deployment - quickly deploying web application


    The Node.js runtime environment has been installed locally.

    Local development

    1. Refer to the Koa.js official documentation to install the Koa environment and initialize your Koa project. The following takes hello world as an example. The content of app.js is as follows:
    // app.js
    const Koa = require('koa');
    const app = new Koa();
    const main = ctx => {
    ctx.response.body = 'Hello World';
    1. In the root directory, run the following command to directly start the service locally.

      node app.js
    2. Visit http://localhost:3000 in a browser, and you can access the sample Koa project locally.

    Deployment in cloud

    You need to make simple modifications to the initialized project, so that the project can be quickly deployed through an HTTP-triggered function. The project transformation here is usually divided into the following two steps:

    • Change the listening address and port to
    • Add the scf_bootstrap file.

    The detailed steps are as follows:

    1. In the sample Koa project, change the listening port to 9000.
    2. Create the scf_bootstrap file in the root directory of the project and add the following content to it (the file is used to configure environment variables and start the service):

      You can also complete the configuration in the console.

      /var/lang/node12/bin/node app.js

    After the file is created, you need to run the following command to modify the executable permission of the file. By default, the permission 777 or 755 is required for the service to start normally. Below is the sample code:

    chmod 777 scf_bootstrap
    1. After the local configuration is completed, run the bootstrap file and make sure that your service can be normally started locally. Then log in to the SLS console, select Web Application > Koa Framewpork, and select Local Upload or Code Repository Pull as the upload mode.

    You can configure the scf_bootstrap file in the console. When the configuration is completed, the console automatically generates the scf_bootstrap file and packages it and the project code for deployment.


    The actual scf_bootstrap file in your project prevails. If the scf_bootstrap file already exists in your project, its content will not be overwritten.

    When the configuration is completed, click Complete to deploy your Koa project.

    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support