### Start NOC with Gufo Thor

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/index.md

Use this command to start the NOC service after installation or configuration.

```shell
gufo-thor up
```

--------------------------------

### Example Gufo Thor Configuration

Source: https://github.com/gufolabs/gufo_thor/blob/master/README.md

An example of the thor.yml configuration file structure. This file defines settings for NOC version, installation name, domain, port, and services.

```yaml
# Gufo Thor configuration
version: "1.0"
noc:
  tag: master
  installation_name: Unconfigured Installation
expose:
  domain_name: go.getnoc.com
  port: 32777
services: [web, card]

```

--------------------------------

### Serve Documentation Locally

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Start a local development server to preview the MkDocs documentation.

```bash
mkdocs serve

```

--------------------------------

### Simple Web-Only Template

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/templates.md

Configuration for a simple web-only installation.

```yaml
--8<-- "src/gufo/thor/samples/simple.yml"
```

--------------------------------

### Install Gufo Thor

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/index.md

Run this command to install or update Gufo Thor. It downloads and executes the installer script.

```shell
curl https://sh.gufolabs.com/thor | sh
```

--------------------------------

### Common Template

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/templates.md

Configuration for an installation with a web interface, hardware integration, and an event-processing pipeline.

```yaml
--8<-- "src/gufo/thor/samples/common.yml"
```

--------------------------------

### NOC Installation Name

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Sets the installation name as displayed in the web interface. The default value is 'Unconfigured Installation'.

```yaml
noc:
    installation_name: "ACME INC"
```

--------------------------------

### Generate Sample Configuration

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/index.md

Generate a sample configuration file for Gufo Thor. Replace <name> with 'simple', 'common', or 'lab1' for different setups.

```shell
gufo-thor sample-config -t <name>
```

--------------------------------

### Check Gufo Thor Installation

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/installation.md

Verify that Gufo Thor has been installed correctly by importing the module and checking its version.

```bash
gufo-thor version
```

--------------------------------

### Specify Starting Node of a Link

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Defines the starting node for a network link.

```yaml
labs:
  lab1:
    links:
      - node-a: r1
```

--------------------------------

### Lab1 Template

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/templates.md

Configuration for a full hardware-integration stack with a sample lab setup including 3 VyOS routers connected in a ring.

```yaml
--8<-- "src/gufo/thor/samples/lab1.yml"
```

--------------------------------

### List of Service Names

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/services.md

Specify services to start using a simple list of their names.

```yaml
services: [web, card]
```

--------------------------------

### Upgrade Gufo Thor Installation

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/installation.md

Use pip to upgrade an existing Gufo Thor installation to the latest version.

```bash
pip3 install --upgrade gufo-thor
```

--------------------------------

### Destroy Gufo Thor Installation

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Destroys the Gufo Thor installation and frees up associated resources.

```bash
gufo-thor destroy
```

--------------------------------

### Python VENV Installation of Gufo Thor

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/installation.md

This method is suitable for evaluation, testing, and development. It sets up a Python virtual environment to isolate Thor and its libraries.

```bash
python -m venv .
. ./bin/activate
curl https://sh.gufolabs.com/thor | sh
```

--------------------------------

### Configure mTLS CA Certificate Path

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/expose.md

Enable mTLS by defining the path to the CA chain, relative to the `assets` directory. For example, use `assets/ca.crt`.

```yaml
expose:
    mtls_ca_cert: ca.crt
```

--------------------------------

### Serve Documentation

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Rebuilds and serves the project documentation locally. This is useful for previewing changes.

```shell
mkdocs serve
```

--------------------------------

### Generate Sample Configuration

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/templates.md

Use this command to generate a sample configuration file for a specified template.

```shell
gufo-thor sample-config -t <template name>
```

--------------------------------

### Generate Sample Configuration

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Generates a sample configuration file based on a specified template name. Refer to the Configuration Templates documentation for available templates.

```bash
gufo-thor sample-config -t <config_name>
```

--------------------------------

### Build and Deploy Documentation

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Build the MkDocs documentation and deploy it to GitHub Pages. The --strict flag enforces checks, and --force overwrites existing content.

```bash
mkdocs gh-deploy --strict --force

```

--------------------------------

### Build Source Distribution and Wheel

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Package the project into a source distribution (sdist) and a wheel file.

```bash
python -m build --sdist --wheel

```

--------------------------------

### Build Package

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Builds the package as both a source distribution and a wheel. Compiled packages will be available in the 'dist/' directory.

```shell
python -m build --sdist --wheel
```

--------------------------------

### NOC Migration Setting

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Controls whether to run migrations on startup. The default value is 'True'.

```yaml
noc:
    migrate: true
```

--------------------------------

### Configure Web Interface Address and Port

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/expose.md

Specify the address and port for the web interface. Defaults to localhost and a specific port.

```yaml
expose:
    web:
        address: 127.0.0.1
        port: 32777
```

--------------------------------

### Configure Domain Name

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/expose.md

Set the domain name for the web interface. The default is `go.getnoc.com`. Changing this requires manual certificate generation and signing.

```yaml
expose:
    domain_name: go.getnoc.com
```

--------------------------------

### Prepare Gufo Thor Environment

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Generates all necessary configuration files for Gufo Thor without launching the Network Operations Center (NOC).

```bash
gufo-thor prepare
```

--------------------------------

### Format Code with Ruff

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Format Python code in the src/ and tests/ directories using Ruff.

```bash
ruff format src/ tests/

```

--------------------------------

### Expose PostgreSQL Port

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/expose.md

Configure the port for exposing PostgreSQL to the host.

```yaml
expose:
    postgres: 5432
```

--------------------------------

### Run Ruff Linting in Docker

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Execute Ruff linting within the development container. This ensures consistent linting across environments.

```bash
$ docker run --rm -v .:/workspaces/gufo_thor -w /workspaces/gufo_thor gufo_thor_dev ruff check src/ tests/

```

--------------------------------

### Run Gufo Thor Shell

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Opens an interactive shell for managing Gufo Thor and NOC processes.

```bash
gufo-thor shell
```

--------------------------------

### Set Number of Service Instances

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/services.md

Configure the number of instances to launch for a scalable service.

```yaml
services:
    web:
        scale: 4
```

--------------------------------

### Run Coverage Report

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Generate a code coverage report after running tests.

```bash
coverage run -m pytest -vv
coverage report

```

--------------------------------

### Configure SNMP Credentials for a Node

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Sets up SNMP credentials for a node, including the protocol version and community string.

```yaml
labs:
  lab1:
    nodes:
      r1:
        snmp:
          - version: v2c
            community: public
```

--------------------------------

### Enable Automatic Browser Opening

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/expose.md

If set to `true`, the web interface URL will be opened in the browser automatically upon running `gufo-thor up`.

```yaml
expose:
    open_browser: true
```

--------------------------------

### Lint Code with Ruff

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Check Python code in the src/ and tests/ directories for linting errors using Ruff.

```bash
ruff check src/ tests/

```

--------------------------------

### Enable Protocols on a Link

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Configures the protocols that will be enabled on a specific network link.

```yaml
labs:
  lab1:
    links:
      - protocols:
          isis:
            metric: 1000
```

--------------------------------

### Build Dev Docker Image

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Build the 'dev' stage of the Docker image. This is used to run linters within the development container.

```bash
$ docker build --target dev -t gufo_thor_dev .

```

--------------------------------

### Run Test Suite

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Executes the project's test suite using pytest.

```shell
pytest -vv
```

--------------------------------

### Define a Basic Network Lab

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

This snippet shows the basic structure for defining a network lab with two nodes and a link between them, including IS-IS protocol configuration.

```yaml
labs:
  lab1:
    pool: test
    nodes:
      r1:
        type: vyos15
        router-id: 10.0.0.1
      r2:
        type: vyos15
        router-id: 10.0.0.2
    links:
      - prefix: 10.0.1.0/30
        node-a: r1
        node-b: r2
        protocols:
          isis:
            metric: 1000
```

--------------------------------

### Expose MongoDB Port

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/expose.md

Configure the port for exposing MongoDB to the host.

```yaml
expose:
    mongo: 27017
```

--------------------------------

### Show Gufo Thor Process Logs

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Displays the logs for a specific Network Operations Center (NOC) process. Can be used in follow mode to stream logs.

```bash
gufo-thor logs <process name>
```

```bash
gufo-thor logs web
```

```bash
gufo-thor logs -f <process name>
```

--------------------------------

### Service Configuration Mapping

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/services.md

Define services with specific configuration items using a mapping.

```yaml
services:
  web:
    scale: 4
  card:
    scale: 2
```

--------------------------------

### Run Tests for Coverage

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Runs the test suite with coverage enabled to collect test execution data.

```shell
coverage run -m pytest -vv
```

--------------------------------

### Generate HTML Coverage Report

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Generates an HTML report detailing line-by-line code coverage. The report can be viewed by opening 'dist/coverage/index.html' in a browser.

```shell
coverage html
```

--------------------------------

### Run Ruff Formatting Check in Docker

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Check code formatting using Ruff within the development container. This verifies that code adheres to the project's style guidelines.

```bash
$ docker run --rm -v .:/workspaces/gufo_thor -w /workspaces/gufo_thor gufo_thor_dev ruff format --check src/ tests/

```

--------------------------------

### Activate Virtual Environment

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/index.md

Activate the Python virtual environment (venv) before using Thor commands if you are in venv mode.

```shell
. ./bin/activate
```

--------------------------------

### NOC Web Interface Theme

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Configures the web interface theme. Accepted values are 'noc' or 'gray'. The default value is 'noc'.

```yaml
noc:
    theme: noc
```

--------------------------------

### Stop NOC with Gufo Thor

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/index.md

Use this command to gracefully stop the NOC service.

```shell
gufo-thor stop
```

--------------------------------

### Define User Credentials for a Node

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Configures user credentials, including username and password, for a specific node.

```yaml
labs:
  lab1:
    nodes:
      r1:
        users:
          - user: user1
            password: secret1
```

--------------------------------

### Run Pytest Tests

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Execute all tests using pytest with verbose output.

```bash
pytest -vv

```

--------------------------------

### Show Gufo Thor Process Statistics

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Displays statistics for the running Network Operations Center (NOC) processes.

```bash
gufo-thor stats
```

--------------------------------

### NOC Custom Code Path

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Defines the path for NOC custom code, allowing customizations to be mounted from the local host.

```yaml
noc:
    custom: /home/joe/work/noc-custom
```

--------------------------------

### Restart Gufo Thor Process

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Restarts a specific Gufo Thor process. Provide the name of the process to restart.

```bash
gufo-thor restart <process name>
```

```bash
gufo-thor restart web
```

--------------------------------

### Basic Pool Definition

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/pools.md

Defines a network pool named 'mypool' with a specified subnet.

```yaml
pools:
  mypool:
    subnet: 10.0.2.0/24
```

--------------------------------

### NOC Web Interface Language

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Sets the web interface language. Accepted values are 'en' (English) or 'ru' (Russian).

```yaml
noc:
    language: en
```

--------------------------------

### Generate Coverage Report

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Generates a text-based report of the code coverage after tests have been run with coverage enabled.

```shell
coverage report
```

--------------------------------

### Upgrade Gufo Thor

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Upgrades Gufo Thor to the latest available version.

```bash
gufo-thor upgrade
```

--------------------------------

### NOC Docker Image Tag

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Sets the Docker image tag for the NOC component. The default value is 'master'.

```yaml
noc:
    tag: "24.1"
```

--------------------------------

### Specify Node Type

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Sets the type of the network node. 'vyos15' is a supported type for virtual routers.

```yaml
labs:
  lab1:
    nodes:
      r1:
        type: vyos15
```

--------------------------------

### Pool with Specific Addresses

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/pools.md

Assigns specific IP addresses to gateway, syslog, and trap services within a pool.

```yaml
pools:
  mypool:
    address:
      gw: 10.0.2.1
      syslog: 10.0.2.2
      trap: 10.0.2.3
```

--------------------------------

### Set Project Name

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/project.md

Specify a custom name for your project. This name will be used as a prefix for all Docker containers created by this Thor project.

```yaml
project: mynoc
```

--------------------------------

### NOC Source Code Path Override

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/noc.md

Specifies the NOC source code path to override the container's default '/opt/noc'. This is useful for development to expose local changes directly in the container.

```yaml
noc:
    path: /home/joe/work/noc
```

--------------------------------

### Run Mypy Type Checking in Docker

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Perform strict type checking using Mypy within the development container. This helps catch type-related errors early.

```bash
$ docker run --rm -v .:/workspaces/gufo_thor -w /workspaces/gufo_thor gufo_thor_dev mypy --strict src/

```

--------------------------------

### Check Code Formatting

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Checks Python code for formatting errors according to project standards. This command does not fix errors.

```shell
ruff format --check examples/ src/ tests/
```

--------------------------------

### Uninstall Gufo Thor

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/installation.md

Use pip to uninstall Gufo Thor from your system.

```bash
pip3 uninstall gufo-thor
```

--------------------------------

### Specify Link Network Prefix

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Sets the network prefix for a link, typically a /30 subnet.

```yaml
labs:
  lab1:
    links:
      - prefix: 10.0.1.0/30
```

--------------------------------

### Specify Username for Node User

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Sets the username for a user account on a node.

```yaml
labs:
  lab1:
    nodes:
      r1:
        users:
          - user: user1
```

--------------------------------

### Unpause Gufo Thor Services

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Resumes the execution of Gufo Thor services that were previously paused.

```bash
gufo-thor unpause
```

--------------------------------

### Define Links Between Nodes

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Defines the network links connecting nodes within a lab. Each link is described as an item in a list.

```yaml
labs:
  lab1:
    links:
      - prefix: 10.0.1.0/30
        node-a: r1
        node-b: r2
        protocols:
          isis:
            metric: 1000
```

--------------------------------

### Type Check Code with Mypy

Source: https://github.com/gufolabs/gufo_thor/blob/master/AGENTS.md

Perform strict type checking on the src/ directory using Mypy.

```bash
mypy --strict src/

```

--------------------------------

### Specify Password for Node User

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Sets the plaintext password for a user account on a node.

```yaml
labs:
  lab1:
    nodes:
      r1:
        users:
          - password: secret1
```

--------------------------------

### Pause Gufo Thor Services

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/cli.md

Temporarily pauses all Gufo Thor services' containers.

```bash
gufo-thor pause
```

--------------------------------

### Attach Lab to a Dedicated Pool

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Specifies a dedicated pool for a lab. If a pool is set, one of the nodes must be designated as the pool gateway.

```yaml
labs:
  lab1:
    pool: test
```

--------------------------------

### Fix Code Formatting

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Fixes Python code formatting errors in the specified directories.

```shell
ruff format src/ tests/
```

--------------------------------

### Define Nodes in a Lab

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Defines the list of network nodes within a lab. Node names are used as keys for their configurations.

```yaml
labs:
  lab1:
    nodes:
      r1:
        type: vyos15
        router-id: 10.0.0.1
      r2:
        type: vyos15
        router-id: 10.0.0.2
```

--------------------------------

### Check Python Code Lints

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Checks Python code for linting errors using ruff. This command checks for errors but does not fix them.

```shell
ruff examples/ src/ tests/
```

--------------------------------

### Configure Node Router ID

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Assigns a router ID to the loopback interface of a node.

```yaml
labs:
  lab1:
    nodes:
      r1:
        router-id: 10.0.0.1
```

--------------------------------

### Setting Default Gateway Address

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/pools.md

Configures the default gateway address for a pool. If not set, it uses the first available IP from the subnet.

```yaml
pools:
  mypool:
    address:
      gw: 10.0.2.1
```

--------------------------------

### Override Docker Image Tag for a Service

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/services.md

Set a specific Docker image tag for a service, overriding the global tag setting.

```yaml
services:
    web:
        tag: "stable"
```

--------------------------------

### Setting Syslog Collector Address

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/pools.md

Assigns a specific IP address for the syslog collector service within a pool.

```yaml
pools:
  mypool:
    address:
      syslog: 10.0.2.2
```

--------------------------------

### Designate a Pool Gateway Node

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Marks a specific node within the lab to serve as the gateway to the designated pools. Only one node per lab can be designated as a pool gateway.

```yaml
labs:
  lab1:
    nodes:
      r1:
        pool-gw: true
```

--------------------------------

### Specify Ending Node of a Link

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/labs.md

Defines the ending node for a network link.

```yaml
labs:
  lab1:
    links:
      - node-b: r2
```

--------------------------------

### Check Python Code Static Typing

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/dev/testing.md

Performs static type checking on Python code using mypy in strict mode. This helps catch typing errors.

```shell
mypy --strict src/
```

--------------------------------

### Setting Trap Collector Address

Source: https://github.com/gufolabs/gufo_thor/blob/master/docs/reference/config/pools.md

Assigns a specific IP address for the trap collector service within a pool.

```yaml
pools:
  mypool:
    address:
      trap: 10.0.2.3
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.