Installing Checkmate
Last updated
Was this helpful?
Last updated
Was this helpful?
Download our
Run docker compose up
to start the application
Now the application is running at http://localhost
Optional Config:
If you want to monitor Docker containers, uncomment this line in docker-compose.yaml
:
This gives the app access to your docker daemon via unix socket, please be aware of what you are doing.
Download our
Edit the UPTIME_APP_API_BASE_URL
variable in the docker-compose file to point to your remote server.
Run docker compose up
to start the application
Now the application is running at http://<remote_server_ip>
Optional Config:
If you want to monitor Docker containers, uncomment this line in docker-compose.yaml
:
This gives the app access to your docker daemon via unix socket, please be aware of what you are doing.
This application consists of a frontend (client) and a backend (server). We recommend you create a directory, let's call it checkmate
, to hold both the Client and the Server in one location.
CD into your checkmate
directory
This application requires a MongoDB instance and a Redis instance. If you want, you can use our Docker images. Otherwise you can provide your own instances.
From your checkmate
directory you created above, cd into server/docker/dev
.
Run docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis
Run docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo
The default Checkmate Redis Docker image does not include authentication. If your setup requires authentication (e.g especially if you are exposing the server on a public IP), you'll need to configure it manually.
The server requires some configuration in order to run.
From your checkmate
directory, CD into the server
directory.
Run npm install
.
In the server
directory, create a .env
file to hold your configuration. This is where you'll add your environment variables.
Start the server
by running npm run dev
.
The client also requires some configuration in order to run.
From your checkmate
directory, CD into the client
directory.
Run npm install
.
In the client
directory, create a .env
file to hold your configuration. This is where you'll add your environment variables.
Start the client
by running npm run dev
The client
is running at localhost:5173
(unless you changed the default port).
The server
is running at localhost:5000
(unless you changed the default port).
Change directory to the Client
directory
Install all dependencies by running npm install
Add a .env
file to the Client
directory with the following options:
VITE_APP_API_BASE_URL
Required
string
Base URL of server
{host}/api/v1
VITE_APP_LOG_LEVEL
Optional
string
Log level
"none"
|"error"
| "warn"
|
VITE_APP_DEMO
Optional
boolean
Demo server or not
true
|false
|
Sample ENV file:
Change the directory to the Server
directory
Install all dependencies by running npm install
Add a .env
file to the Server
directory with the following options:
Configure the server with the following environmental variables. Note that those variables need to be set in .env
files if you are running the local development server, or in the Docker compose file if you use docker compose.
CLIENT_HOST
Required
string
Frontend Host
JWT_SECRET
Required
string
JWT secret
REFRESH_TOKEN_SECRET
Required
string
Refresh JWT secret
DB_TYPE
Optional
string
Specify DB to use
MongoDB | FakeDB
DB_CONNECTION_STRING
Required
string
Specifies URL for MongoDB Database
PORT
Optional
integer
Specifies Port for Server
LOGIN_PAGE_URL
Required
string
Login url to be used in emailing service
REDIS_HOST
Required
string
Host address for Redis database
REDIS_PORT
Required
integer
Port for Redis database
TOKEN_TTL
Optional
string
Time for token to live
In vercel/ms format https://github.com/vercel/ms
REFRESH_TOKEN_TTL
Optional
string
Time for refresh token to live
PAGESPEED_API_KEY
Optional
string
API Key for PageSpeed requests
SYSTEM_EMAIL_HOST
Required
string
Host to send System Emails From
SYSTEM_EMAIL_PORT
Required
number
Port for System Email Host
SYSTEM_EMAIL_ADDRESS
Required
string
System Email Address
SYSTEM_EMAIL_PASSWORD
Required
string
System Email Password
Sample env file
You can see the documentation on your local development server at http://localhost:{port}/api-docs
Errors are returned in a standard format:
{"success": false, "msg": "No token provided"}
Errors are handled by error handling middleware and should be thrown with the following parameters
status
integer
500
Standard HTTP codes
message
string
"Something went wrong"
An error message
service
string
"Unknown Service"
Name of service that threw the error
Example:
Errors should not be handled at the controller level and should be left to the middleware to handle.
Clone the . We'll refer to this directory as client
Clone the . We'll refer to this directory as server
Add the .
Add the .
Note that for the Pagespeed feature to work, you need a
Our API is documented in accordance with the .
You can also view the documentation on our demo server at