# | nix-amer |

[![Go version](https://img.shields.io/badge/go_version-1.11-blue.svg)](https://golang.org/doc/go1.11)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Go Report Card](https://goreportcard.com/badge/github.com/xdrm-brackets/nix-amer)](https://goreportcard.com/report/github.com/xdrm-brackets/nix-amer)
[![Coverage Status](https://coveralls.io/repos/github/xdrm-brackets/nix-amer/badge.svg?branch=meta%2Fcircle-ci)](https://coveralls.io/github/xdrm-brackets/nix-amer?branch=meta%2Fcircle-ci)
[![CircleCI Build Status](https://circleci.com/gh/xdrm-brackets/nix-amer.svg?style=shield)](https://circleci.com/gh/xdrm-brackets/nix-amer)
[![Go doc](https://godoc.org/github.com/xdrm-brackets/nix-amer?status.svg)](https://godoc.org/github.com/xdrm-brackets/nix-amer)

```yaml
name:        nix-amer
version:     0.1.0
description: Configuration automation tool
author:      xdrm-brackets
```

>Need to automate the setup of your linux server or desktop ? This tool is made for you.

<!-- toc -->

  * [I. Commands](#i-commands)
    + [1) Comments](#1-comments)
    + [2) package management](#2-package-management)
    + [3) setup configuration](#3-setup-configuration)
    + [4) service management](#4-service-management)
    + [5) aliases](#5-aliases)
    + [6) custom scripts](#6-custom-scripts)
  * [II. Path Expressions](#ii-path-expressions)
    + [File Formats](#file-formats)
- [Example](#example)

<!-- tocstop -->

----



### I. Commands

Your whole setup remains in 1 only build file. Each line contains one instruction, the list of instructions is listed below.



#### 1) Comments

Each line beginning with one of the following characters : `[`, `#` or `;` is considered a comment and is not interpreted.



#### 2) package management

These instructions allow you to interact with the package system available on your system.

```
install <packages>
```
Install the listed packages. If more than one, use spaces to separate package names.



```
delete <packages>
```
Remove the listed packages. If more than one, use spaces to separate package names.



#### 3) setup configuration

This instruction allow you to set fields of configuration files without the need of an editor and in a developer-readable manner.

```
set <expr> <content>
```
Update a configuration file where \<expr\> is a dot-separated human-readable [path expression](#ii-path-expressions) and \<content\> is a string or a file. If a string is given, it will <u>override/add the field</u> ; if a file is given the configuration file will be <u>replaced</u> by it.




#### 4) service management

These instructions allow you to interact with the service system (_cf. [systemd](https://github.com/systemd/systemd)_).

```
service [enable|start|stop|restart|reload] <services>
```
Perform the action on services. If more than one, use spaces to separate service names.



#### 5) aliases

The file format allows you to create aliases to file paths for more readability in the [path expression](#ii-path-expressions) or with the [`run` command](#6-custom-scripts).

```
alias name /path/to.file
```

Create the alias `name` which resolves to the path `/path/to.file`.

> Alias value either for the `set` or `run` command have priority to real file paths.



#### 6) custom scripts

These instructions allow you to use custom scripts for complex operations.

```
run <script>
```

Execute the executable located at the path \<script\>. If script is an [alias](#5-aliases) it will resolve to its path



----



### II. Path Expressions

The syntax is pretty fast-forward, it uses 2 levels (file, fields) to find your configuration line : `location_or_alias@fields`.

| Field     | Description                          | Example                    |
| --------- | :----------------------------------- | -------------------------- |
| `location_or_alias` | Path to the configuration file to edit. The file will be created if not found. If the path is an [alias](#5-aliases) created before in the file, it will resolve to the alias value as a filename. | `/etc/nginx/nginx.conf`, `some-alias` |
| `fields` | Dot-separated chain of strings that match a configuration field. If the field does not point to a raw field but an existing field container, the \<value\> will replace the group with a text value. | `AllowGroups`, `http.gzip` |

> The `fields` is processed only for known file formats listed in this [section](#file-formats).



#### File Formats

Configuration files can be written according to some standards or application-specific syntax. This tool uses standard and third-party to parse the following formats :

- [xml](https://fr.wikipedia.org/wiki/Extensible_Markup_Language) and [json](https://json.org/) are read/written using the go standard library (_cf. [json](https://golang.org/pkg/encoding/json/), [xml](https://golang.org/pkg/encoding/xml/)_).

> xml is not yet supported ; complex structure the library outputs (attributes vs. content) to understand better

- [yaml](https://en.wikipedia.org/wiki/YAML) with [go-yaml/yaml](https://github.com/go-yaml/yaml).
- [ini](https://en.wikipedia.org/wiki/INI_file) with [go-ini/ini](https://github.com/go-ini/ini).

-  [nginx configurations](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/) with [my own library](https://godoc.org/github.com/xdrm-brackets/nix-amer/internal/cnf/parser/nginx).
-  _and more to come..._



----

## Example

Launch the following command to install your server :

```bash
$ nix-amer -p apt-get myserver.build
```

> Replace `apt-get` by your package manager; `nix-amer -help` for available options.



_myserver.build_

```
[ comment starts with opening brackets '['

[aliases]
alias sshd  /etc/ssh/sshd_config
alias nginx /etc/nginx/nginx.conf
alias sslh  /etc/default/sslh

[install packages]
install nginx ssh
install sslh

[nginx]
set nginx@http.gzip           off
service enable nginx
service start nginx

[sshd]
set sshd@PermitRootLogin      no
set sshd@PermitEmptyPasswords no
service enable sshd
service enable ssh

[sslh]
set sslh@RUN                  yes
set sslh@DEAMON_OPTS          "--user sslh --listen 0.0.0.0:443 --ssh 127.0.0.1:22 --ssl 127.0.0.1:44300 --pidfile /var/run/sslh/sslh.pid"
service enable sslh
service start sslh
```