Introduction

Deployer is a tool that makes continous delivery to your VPS easy. All you have to do is push your code, and deployer takes care of the rest.

The tool makes use of webkooks (opens new window) provided by your code hosting provider. Deployer currently supports Github (opens new window), Bitbucket (opens new window) and Gitlab (opens new window).

Getting started

Backend setup.

1. Cloning

   $ git clone https://github.com/opensource254/deployer.git
   $ cd deployer
   $ npm install --production
   $ cp .env.example .env
   

2. Add your configuration to the .env file. The most important of all is the database config

   DATABASE_HOST=<your database host>
   DATABASE_USER=<your database username>
   DATABASE_PASSWORD=<your database password>
   DATABASE_NAME=<the name of the databse to be used>
   DATABASE_CLIENT=mysql,postgres,sqlite etc
   
   COOKIE_DOMAIN=<the domain that the deployer is being hosted>
   

   Please refer to config for a detailed configuration documentation
3. Run the migrations bash $ npm run migrate:prod This will create the tables necessary.
4. Create an admin by running node setup and anwering the promts correctly. In production environments it is not possible to create a user via the API
5. Run the application with npm run start or yarn start. The application runs on localhost:3232 (opens new window) by default.

Client setup

Deployer comes with an official client which can be found here (opens new window). You do not have to use it though. You can create your own.

1. Setting up

$ git clone https://github.com/opensource254/deployer-client.git
$ cd deployer-client && cp .env.example .env && yarn

2. Configure the client. Add the API_URL value in your .env. The API_URL is the URL of the deployer server. Please make sure you are hosting in in a domain.
3. Build your application with yarn build and run it with yarn start. Please refer to Nuxt (opens new window) for more options. Your application will run on localhost:4010 (opens new window) by default.