# Gufo Thor
*A simple [NOC][NOC] management and deployment tool.*
[](https://pypi.python.org/pypi/gufo_thor/)
[](https://opensource.org/licenses/BSD-3-Clause)
[](https://github.com/charliermarsh/ruff)
---
**Documentation**: [https://docs.gufolabs.com/gufo_thor/](https://docs.gufolabs.com/gufo_thor/)
**Source Code**: [https://github.com/gufolabs/gufo_thor/](https://github.com/gufolabs/gufo_thor/)
---
Gufo Thor is a simple tool designed for quickly setting up and evaluating [NOC][NOC].
It's tailored for new NOC users who want to assess NOC's capabilities and NOC developers
who need a fast development environment. Thor takes care of the complexity of NOC management,
making the process straightforward.
## Prerequisites
To use Thor, make sure you have the following software packages installed:
- Docker
- docker-compose or the compose plugin
- Python 3.8+
## Installation
To install or update Thor, follow these steps:
1. Create a dedicated directory where all configuration files will be stored.
2. Navigate to the newly created directory.
3. Run the installer:
```
curl https://sh.gufolabs.com/thor | sh
```
4. After installation, NOC will be launched,
and your browser will open at https://go.getnoc.com:32777/
5. Log in as user `admin` with password `admin`.
## NOC Operations Cheat List
Execute all actions from the directory containing the Thor configuration.
If you are using venv mode, ensure to activate the virtual environment (venv) before utilizing Thor.
``` shell
. ./bin/activate
```
### Start NOC
Use the following command to start NOC:
```
gufo-thor up
```
Once NOC is ready, you will be redirected to https://go.getnoc.com:32777/
Log in using the following credentials:
- **Username:** admin
- **Password:** admin
### Stop NOC
To stop NOC, use the command:
```
gufo-thor stop
```
## Configuration
Thor's configuration is in the thor.yml file. You can use preconfigured defaults:
```
gufo-thor sample-config -t <name>
```
Where `<name>` can be:
* `simple` - Minimal setup with a web interface only.
* `common` - Setup with widely-used features for monitoring and network management.
The thor.yml structure:
```
# Gufo Thor configuration
version: "1.0"
noc:
tag: master
installation_name: Unconfigured Installation
expose:
domain_name: go.getnoc.com
port: 32777
services: [web, card]
```
Adapt the file to your needs and start NOC:
```
gufo-thor up
```
## On Gufo Stack
This product is a part of [Gufo Stack][Gufo Stack] - the collaborative effort
led by [Gufo Labs][Gufo Labs]. Our goal is to create a robust and flexible
set of tools to create network management software and automate
routine administration tasks.
To do this, we extract the key technologies that have proven themselves
in the [NOC][NOC] and bring them as separate packages. Then we work on API,
performance tuning, documentation, and testing. The [NOC][NOC] uses the final result
as the external dependencies.
[Gufo Stack][Gufo Stack] makes the [NOC][NOC] better, and this is our primary task. But other products
can benefit from [Gufo Stack][Gufo Stack] too. So we believe that our effort will make
the other network management products better.
[Gufo Labs]: https://gufolabs.com/
[Gufo Stack]: https://gufolabs.com/products/gufo-stack/
[NOC]: https://getnoc.com/
Raw data
{
"_id": null,
"home_page": null,
"name": "gufo-thor",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "NOC",
"author": "Gufo Labs",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/51/f8/b7595aae7f20abbbe8b925fc6937aab980653fd3689a4c7e7efb778905a4/gufo_thor-0.6.0.tar.gz",
"platform": null,
"description": "# Gufo Thor\n\n*A simple [NOC][NOC] management and deployment tool.*\n\n[](https://pypi.python.org/pypi/gufo_thor/)\n\n[](https://opensource.org/licenses/BSD-3-Clause)\n\n\n[](https://github.com/charliermarsh/ruff)\n\n---\n\n**Documentation**: [https://docs.gufolabs.com/gufo_thor/](https://docs.gufolabs.com/gufo_thor/)\n\n**Source Code**: [https://github.com/gufolabs/gufo_thor/](https://github.com/gufolabs/gufo_thor/)\n\n---\nGufo Thor is a simple tool designed for quickly setting up and evaluating [NOC][NOC].\nIt's tailored for new NOC users who want to assess NOC's capabilities and NOC developers \nwho need a fast development environment. Thor takes care of the complexity of NOC management, \nmaking the process straightforward.\n\n## Prerequisites\n\nTo use Thor, make sure you have the following software packages installed:\n\n- Docker\n- docker-compose or the compose plugin\n- Python 3.8+\n\n## Installation\n\nTo install or update Thor, follow these steps:\n\n1. Create a dedicated directory where all configuration files will be stored.\n2. Navigate to the newly created directory.\n3. Run the installer:\n ```\n curl https://sh.gufolabs.com/thor | sh\n ```\n4. After installation, NOC will be launched,\n and your browser will open at https://go.getnoc.com:32777/\n5. Log in as user `admin` with password `admin`.\n\n## NOC Operations Cheat List\n\nExecute all actions from the directory containing the Thor configuration. \nIf you are using venv mode, ensure to activate the virtual environment (venv) before utilizing Thor.\n\n``` shell\n. ./bin/activate\n```\n\n### Start NOC\nUse the following command to start NOC:\n\n```\ngufo-thor up\n```\n\nOnce NOC is ready, you will be redirected to https://go.getnoc.com:32777/\nLog in using the following credentials:\n\n- **Username:** admin\n- **Password:** admin\n\n### Stop NOC\n\nTo stop NOC, use the command:\n\n```\ngufo-thor stop\n```\n\n## Configuration\n\nThor's configuration is in the thor.yml file. You can use preconfigured defaults:\n\n```\ngufo-thor sample-config -t <name>\n```\n\nWhere `<name>` can be:\n\n* `simple` - Minimal setup with a web interface only.\n* `common` - Setup with widely-used features for monitoring and network management.\n\nThe thor.yml structure:\n```\n# Gufo Thor configuration\nversion: \"1.0\"\nnoc:\n tag: master\n installation_name: Unconfigured Installation\nexpose:\n domain_name: go.getnoc.com\n port: 32777\nservices: [web, card]\n```\n\nAdapt the file to your needs and start NOC:\n\n```\ngufo-thor up\n```\n\n## On Gufo Stack\n\nThis product is a part of [Gufo Stack][Gufo Stack] - the collaborative effort \nled by [Gufo Labs][Gufo Labs]. Our goal is to create a robust and flexible \nset of tools to create network management software and automate \nroutine administration tasks.\n\nTo do this, we extract the key technologies that have proven themselves \nin the [NOC][NOC] and bring them as separate packages. Then we work on API,\nperformance tuning, documentation, and testing. The [NOC][NOC] uses the final result\nas the external dependencies.\n\n[Gufo Stack][Gufo Stack] makes the [NOC][NOC] better, and this is our primary task. But other products\ncan benefit from [Gufo Stack][Gufo Stack] too. So we believe that our effort will make \nthe other network management products better.\n\n[Gufo Labs]: https://gufolabs.com/\n[Gufo Stack]: https://gufolabs.com/products/gufo-stack/\n[NOC]: https://getnoc.com/\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License",
"summary": null,
"version": "0.6.0",
"project_urls": {
"Bug Tracker": "https://github.com/gufolabs/gufo_thor/issues",
"Changelog": "https://github.com/gufolabs/gufo_thor/blob/master/CHANGELOG.md",
"Documentation": "https://docs.gufolabs.com/gufo_thor/",
"Homepage": "https://github.com/gufolabs/gufo_thor/",
"Source Code": "https://github.com/gufolabs/gufo_thor/"
},
"split_keywords": [
"noc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58f6e798167a2190eadcfa7ccb26d9a82ff89f7ca9b2e6111afe094ef9873dd4",
"md5": "9121c26cfc555f9765e3870bd6f59e85",
"sha256": "0121c33f2a15539e63157a8c11119cec6579070626b4239ec0598567b67fe6b7"
},
"downloads": -1,
"filename": "gufo_thor-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9121c26cfc555f9765e3870bd6f59e85",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 45188,
"upload_time": "2024-08-05T12:42:52",
"upload_time_iso_8601": "2024-08-05T12:42:52.525107Z",
"url": "https://files.pythonhosted.org/packages/58/f6/e798167a2190eadcfa7ccb26d9a82ff89f7ca9b2e6111afe094ef9873dd4/gufo_thor-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "51f8b7595aae7f20abbbe8b925fc6937aab980653fd3689a4c7e7efb778905a4",
"md5": "eb07a166e944050fdb6b8fdc0ea81cc6",
"sha256": "a780537a6a71e6b2248a87f20d6e37d6d1967e795477b615266e2998871568f6"
},
"downloads": -1,
"filename": "gufo_thor-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "eb07a166e944050fdb6b8fdc0ea81cc6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 34316,
"upload_time": "2024-08-05T12:42:54",
"upload_time_iso_8601": "2024-08-05T12:42:54.158010Z",
"url": "https://files.pythonhosted.org/packages/51/f8/b7595aae7f20abbbe8b925fc6937aab980653fd3689a4c7e7efb778905a4/gufo_thor-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-05 12:42:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gufolabs",
"github_project": "gufo_thor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gufo-thor"
}
JSON
