Installation
While the Sunrise Cemetery Management System (CMS) can run on a high end server, that is by no means a requirement. Most user workstations are sufficient for modest installations.
Minimum Requirements
The system must meet the minimum requirements for Node.js, which is able to run on budget hardware.
More is better, however under stress tests, the application peaked at the following:
- 512 MB of RAM
- 1 GB of storage for application, dependencies, and data.
- Active Directory for authentication.
Step 1: Install Node.js 20 or better and npm
Node.js is a JavaScript runtime environment. Sunrise CMS is built to run on Node.js, and is regularly tested on the currently supported LTS versions.
npm is a package manager that contains all the prerequisites for Sunrise CMS.
Node.js can run on Windows, Mac, and Linux. Installers on the Node.js website include npm. Node.js and npm are also available in most package managers.
> sudo apt install nodejs
> sudo apt install npm
Step 2: Install git
Alternatively, releases are available on GitHub. Git is not required when using releases.
Git is the version control system that manages the code for Sunrise CMS.
Git can run on Windows, Mac, and Linux. You can install it using an install on the Git website, or from most package managers.
> sudo apt install git
Step 3: Clone the sunrise-cms repository using git
Open a command line, and navigate to the folder where the application will reside.
> git clone https://github.com/cityssm/sunrise-cms
Step 4: Install the dependencies
> cd sunrise-cms
> npm install
Step 5: Create a config.js file
It is recommended to copy the testing.config.js file to get started.
> cp data/testing.config.js data/config.js
See the config.js documentation for help customizing your configuration.
Step 6: Start the application
Start Using npm
> npm start
Start Using node
> node ./bin/www.js
Start as a Windows Service
The included windowsService-install.bat script simplifies
the process of keeping the application running in a Windows environment
by creating a service that can start with the hosting server.
> windowsService-install