mr-windows-service v3.0.0
MR Windows Service
Instalação
Instale o mr-windows-service
em modo global
$ npm i mr-windows-service --global
Instalando ou removendo o serviço da aplicação
Instalando a aplicação node como serviço
No diretório da aplicação execute o comando:
$ windows-service install
A ferramenta irá considerar as propriedades do arquivo package.json
para a geração do serviço:
name
: para definição do nome do serviçodescription
: para definição da descrição do serviçomain
: para a definição do script de inicialização da aplicação
Observação: Se preferir um nome mais amigável para o serviço utilize a tag displayName
Removendo o serviço
No diretório da aplicação execute o comando:
$ windows-service remove
Atributos
Atributo | Obrigatório | Descrição | Default |
---|---|---|---|
install | Sim | executa a instalação do serviço | |
remove | Sim | remove o serviço instalado | |
--help | - | exibe o help mr-windows-service | |
-? | - | exibe o help mr-windows-service | |
/? | - | exibe o help mr-windows-service | |
-file | Não | permite definir o caminho do arquivo de configuração que contém os atributos do serviço | "./package.json" |
-property | Não | permite definir uma propriedade propriedade no arquivo de configuração que contém os atributos do serviço | |
-displayName | Não | permite definir o displayName do serviço | |
-description | Não | permite definir a descrição do serviço | |
-script | Não | permite definir o script de execução da aplicação | |
-name | Não | permite definir o displayName do serviço (mesmo que displayName) | |
-main | Não | permite definir o script de execução da aplicação (mesmo que script) |
Declarando os atributos do serviço manualmente
A instalação do serviço de forma manual requer os seguintes atributos
displayName
ouname
description
script
oumain
No diretório da aplicação execute o comando:
$ windows-service install -displayName="Nome do Serviço" -description="Descrição do serviço" -script="./index.js"
Para remover basta informar apenas o atributo displayName
ou name
$ windows-service remove -displayName="Nome do Serviço"
Definindo os atributos do serviço em outro arquivo json ou jsonc
Defina os atributos do serviço em um arquivo json ou jsonc e depois execute o comando de instalação informando o caminho do arquivo no atributo file
.
Atributos do serviço:
// arquivo.json
{
"displayName": ".6005 - Document Repository",
"description": "Repositório de Documentos | MRProjetos",
"script": "./server"
}
No diretório da aplicação execute o comando:
$ windows-service install -file="./arquivo.json"
Observação: Para remover o serviço basta substituir o comando install
por remove
.
Se desejar utilizar uma propriedade dentro do arquivo json para definir os atributos do serviço execute o comando de instalação informando o nome da propriedade no atributo property
.
Atributos do serviço:
// arquivo.json
{
"serviceOpts": {
"displayName": ".6005 - Document Repository",
"description": "Repositório de Documentos | MRProjetos",
"script": "./server"
}
}
No diretório da aplicação execute o comando:
$ windows-service install -file="./arquivo.json" -property="serviceOpts"
Observação: Para remover o serviço basta substituir o comando install
por remove
.
9 months ago