TheThing/service-core
1
0
Fork 0
Code Issues Pull requests Projects Releases 22 Wiki Activity
Core boiler plate code to run node application as a service in both windows or linux with auto-update.
110 commits 1 branch 23 tags 2.1 MiB
JavaScript 100%
Find a file
Jonatan Nilsson 6c720f4c2d
All checks were successful
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
Fix git integration test
2024-02-16 06:52:50 +00:00
bin Replace binaries in bin folder with pure 7zdec only for smaller release files 2022-02-15 16:32:43 +00:00
core core: In application, move version into context 2024-02-16 06:48:29 +00:00
test Fix git integration test 2024-02-16 06:52:50 +00:00
.gitignore Some cleanup on files. Remove skip tests 2022-02-18 08:16:36 +00:00
.npmrc Mode development. Boilerplate finished 2020-09-01 17:31:38 +00:00
appveyor.yml Application: Expose some helper classes to application through ctx.sc 2022-03-27 15:12:04 +00:00
cli.mjs cli: Add basic install support for linux 2022-03-13 01:22:45 +00:00
exampleconfig.json Finished basic beta implementation of entire thing. 2022-02-15 11:28:30 +00:00
index.mjs Fixed lib and finished implementing it 2022-03-10 13:08:02 +00:00
package.json core: Update tests after moving version info 2024-02-16 06:50:34 +00:00
README.md Update Readme 2022-01-10 08:49:01 +00:00

README.md

service-core

Service-Core is a project to faciliate running a node application in (semi-)production environment on a windows machine. Using Windows Services, Service-Core will register itself and autostart on startup and make sure the application is running. In addition it will take care of maintaining the application including auto updating it seamlessly.

Notice, linux support is coming soon.

The Core

The core provides methods for updating applications as well as taking care of restarting and installing and everything needed to have a pleasent experience running a node application in Windows. It auto checks github for new releases based on the repository specified in config.json.

The core supports running two applications by default (specified in config.json file):

  • The manage app: Designated UI node app to provide UI interface on top of service-core. Not needed as service-core already does everything by itself but nice to have to remotely read logs and manually trigger updates among other things
  • The main app: The main application service-core is designated to run.

Both the main app and manage app get regular update checks and will automatically be installed if a new version is detected.

API

To build a service-core application I recomennd checking out hello world app but in short, all service core applications require the following things:

  • index.mjs that exposes a function called start(config, db, log, core, http, port)
  • The application in question must use the passed on http parameter to call .createServer(). Otherwise service-core has no way of shutting it down to provide seamless updates among other things.

The start() function gets called with following parameters:

  • config: JSON object containing the entirety of config.json
  • db: A lowdb database available for the application to use. Also used internally in service-core to manage versions.
  • log: A bunyan logger for logging.
    • log.event.info,warn,error(message): Write a log message to the windows event viewer.
  • core: The internal core. Exposes multiple methods for managing service-core
  • http: A wrapped internal node http to call .createServer(). Allows service-core to monitor the server in question.
  • port: The port the application should be listening to.