Guides

Installation

Ops Status is easy to install. You should be up and running in no time by following the instructions below.

1. Prerequisites

Make sure you meet all the prerequisites before proceeding any further.

2. Download

  • Download the latest version of Ops Status from the GitHub project releases.
  • Extract the archive to the folder of your choice. The server will run from this path.

3. Install

Open a command prompt from the directory where you extracted the files in the previous step.

Run the command:

npm install --production

NPM will now download and install all the required dependencies.

4. Configure

A sample configuration file is provided (config.sample.json). Rename it to config.json and open it in your favorite text editor to modify the values.

Configuration Options

  • title: The title of your site, displayed in the browser tab.
  • host: The complete path to where Ops Status can be reached. Do not add a trailing slash!
  • port: On which port should the server listen. Port 80 by default.
  • db: The connection string to connect to MongoDB. More info in the Database Guide.
  • redis: Redis configuration object. More info in the Redis Guide.
  • sessionSecret: A super long, random string of characters, unique to your installation. (256-bit length recommended)
  • admin: The email address to use when creating the default admin account.

5. Run

You can now run the following command to start the NodeJS process:

npm start

Ops Status will now initialize and display a [RUNNING] message when ready.

6. Access the Administration Area

You can access the administration area using the link in the footer or by going to /admin

Login using the admin email you entered in the config file earlier and use the password admin

❗️

Change the admin password!

You should modify the default admin password to something more secure. Leaving it to the default value means anyone can login and modify all aspects of your site!

From the administration area, go to Users and click on the Edit icon next to the admin account to change its password.

Updated less than a minute ago