# mr-windows-service

> Instalador de serviços node em Windows

Latest version **3.0.0** (published 2023-08-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install mr-windows-service
pnpm add mr-windows-service
yarn add mr-windows-service
bun add mr-windows-service
```

Provides the command `windows-service`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2023-08-15 |
| First published | 2023-08-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 14 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Marco Aurélio Rocha |
| Maintainers | maureliorocha |

## Links

- npm: https://www.npmjs.com/package/mr-windows-service
- npm.io page: https://npm.io/package/mr-windows-service

## Dependencies (4)

- [mr-json](https://npm.io/package/mr-json.md) ^1.0.4
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.5
- [@types/node](https://npm.io/package/@types/node.md) ^20.5.0
- [node-windows](https://npm.io/package/node-windows.md) ^1.0.0-beta.8

## Recent versions

- 3.0.0 (latest) — 2023-08-15

## README

# MR Windows Service

## Instalação

### Instale o `mr-windows-service` em modo global
```cmd
$ 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:

```cmd
$ 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ço
- `description`: para definição da descrição do serviço
- `main`: 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:

```cmd
$ 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` ou `name`
- `description`
- `script` ou `main`

No diretório da aplicação execute o comando:
```cmd
$ 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`
```cmd
$ 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:
```json
// arquivo.json
{
  "displayName": ".6005 - Document Repository",
  "description": "Repositório de Documentos | MRProjetos",
  "script": "./server"
}
```

No diretório da aplicação execute o comando:
```cmd
$ 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:
```json
// arquivo.json
{
  "serviceOpts": {
    "displayName": ".6005 - Document Repository",
    "description": "Repositório de Documentos | MRProjetos",
    "script": "./server"
  }
}
```

No diretório da aplicação execute o comando:
```cmd
$ windows-service install -file="./arquivo.json" -property="serviceOpts"
```

**Observação**: Para remover o serviço basta substituir o comando `install` por `remove`.

---
_Source: https://npm.io/package/mr-windows-service · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
