Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: New Website based on Docusaurus #2610

Merged
merged 6 commits into from
Dec 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/mergify.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
pull_request_rules:
- name: automatic merge for pull request based on label and ci success
conditions:
- label~=LGTM$
- check-success=continuous-integration/appveyor/pr
- label~=LGTM$
- check-success=continuous-integration/appveyor/pr
actions:
merge:
method: squash
Expand All @@ -22,7 +22,7 @@ pull_request_rules:
method: squash
- name: automatic merge for ImgBot pull requests based on ci success
conditions:
- author=imgbot[bot]
- author=imgbot[bot]
- check-success=continuous-integration/appveyor/pr
actions:
merge:
Expand Down
53 changes: 53 additions & 0 deletions .github/workflows/deploy_website.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: GitHub Pages

on:
push:
branches:
- main
paths:
- '.github/workflows/deploy_website.yml'
- 'Website/**'
pull_request:

jobs:
build-and-deploy-website:
runs-on: ubuntu-22.04
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
defaults:
run:
working-directory: Website
steps:
- uses: actions/checkout@v3

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: '18'

- name: Get yarn cache
id: yarn-cache
run: echo "YARN_CACHE_DIR=$(yarn cache dir)" >> "${GITHUB_OUTPUT}"

- name: Cache dependencies
uses: actions/cache@v3
with:
path: ${{ steps.yarn-cache.outputs.YARN_CACHE_DIR }}
key: ${{ runner.os }}-Website-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-Website-

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Build website
run: yarn build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./Website/build
2 changes: 1 addition & 1 deletion InnoSetup.iss
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
#define MyAppPublisher "BornToBeRoot"
#define MyAppURL "https://github.com/BornToBeRoot/NETworkManager/"
#define MyAppExeName "NETworkManager.exe"
#define MyAppCopyright "Copyright (C) 2016-2023 BornToBeRoot"
#define MyAppCopyright "Copyright (C) 2016-2024 BornToBeRoot"

[Setup]
; NOTE: The value of AppId uniquely identifies this application. Do not use the same AppId value in installers for other applications.
Expand Down
2 changes: 1 addition & 1 deletion Source/GlobalAssemblyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("")]
[assembly: AssemblyCopyright("Copyright © 2016-2023 BornToBeRoot")]
[assembly: AssemblyCopyright("Copyright © 2016-2024 BornToBeRoot")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

Expand Down
20 changes: 20 additions & 0 deletions Website/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
17 changes: 17 additions & 0 deletions Website/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# NETworkManager website and documentation

Welcome to the new [NETworkManager](https://github.com/BornToBeRoot/NETworkManager) website and documentation.

It's build with [Docusaurus](https://docusaurus.io/), a static website generator, and is hosted on [GitHub Pages](https://pages.github.com/).

You can help to improve the documentation by submitting a pull request.


## Software, services and images used

- [Docusaurus](https://docusaurus.io/)
- [GitHub Pages](https://pages.github.com/)
- [GitHub Actions Workflow](https://github.com/peaceiris/actions-gh-pages)

- Images
- [undraw.co](https://undraw.co/)
3 changes: 3 additions & 0 deletions Website/babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
};
12 changes: 12 additions & 0 deletions Website/blog/2024-01-01-welcome/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
slug: welcome
title: Welcome
authors: [borntoberoot]
tags: [welcome, networkmanager, docusaurus]
---

Welcome to the new NETworkManager website and documentation.

It's build with [Docusaurus](https://docusaurus.io/), a static website generator, and hosted on [GitHub Pages](https://pages.github.com/).

You can help to improve the documentation by submitting a [pull request](https://github.com/BornToBeRoot/NETworkManager-docs).
5 changes: 5 additions & 0 deletions Website/blog/authors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
borntoberoot:
name: BornToBeRoot
title: Maintainer of NETworkManager
url: https://github.com/BornToBeRoot
image_url: https://github.com/BornToBeRoot.png
5 changes: 5 additions & 0 deletions Website/docs/Application/Dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 1
---

# Dashboard
5 changes: 5 additions & 0 deletions Website/docs/Application/IPScanner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 4
---

# IP Scanner
5 changes: 5 additions & 0 deletions Website/docs/Application/PortScanner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 5
---

# Port Scanner
7 changes: 7 additions & 0 deletions Website/docs/Application/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"label": "Application",
"position": 4,
"link": {
"type": "generated-index"
}
}
47 changes: 47 additions & 0 deletions Website/docs/Features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
sidebar_position: 2
---

# Features

The following features are currently available:

- [Dashboard](./Application/Dashboard)
- [Network Interface](./Application/NetworkInterface) - Information, Bandwidth, Configure
- [WiFi](./Application/WiFi) - Networks, Channels
- [IP Scanner](./Application/IPScanner)
- [Port Scanner](./Application/PortScanner)
- [Ping Monitor](./Application/PingMonitor)
- [Traceroute](./Application/Traceroute)
- [DNS Lookup](./Application/DNSLookup)
- [Remote Desktop](./Application/RemoteDesktop)
- [PowerShell](./Application/PowerShell)
- [PuTTY](./Application/PuTTY) (requires [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html))
- [AWS Session Manager](./Application/AWSSessionManager) (requires [AWS CLI](https://aws.amazon.com/cli/) and [AWS Session Manager plugin](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html))
- [TigerVNC](./Application/TigerVNC) (requires [TigerVNC](https://tigervnc.org/))
- [Web Console](./Application/WebConsole) (requires [Microsoft Edge - WebView2 Runtime](https://developer.microsoft.com/en-us/microsoft-edge/webview2/))
- [SNMP](./Application/SNMP) - Get, Walk, Set
- [SNTP Lookup](./Application/SNTPLookup)
- [Discovery Protocol](./Application/DiscoveryProtocol) - LLDP, CDP
- [Wake on LAN](./Application/WakeOnLAN)
- [Whois](./Application/Whois)
- [Subnet Calculator](./Application/SubnetCalculator) - Calculator, Subnetting, Supernetting
- [Bit Calculator](./Application/BitCalculator)
- [Lookup](./Application/Lookup) - OUI, Port
- [Connections](./Application/Connections)
- [Listeners](./Application/Listeners)
- [ARP Table](./Application/ARPTable)

If you have any suggestions for new features, please submit a [feature request](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose) on GitHub.

## Profiles

Save your hosts with specific configurations in profiles and use them across all features. You can seperate them in different profile files for each environment (e.g. work, home, customer, etc.) and encrypt them with a master password to protect your sensitive data.

## Languages

Thanks to the community, NETworkManager is available in more than 15 [languages](https://app.transifex.com/BornToBeRoot/NETworkManager/dashboard/). If you would like to help with the translation and improve it, you can join the translation team on [Transifex](https://app.transifex.com/BornToBeRoot/NETworkManager/dashboard/).

New languages must be requested on GitHub via a [feature request](https://github.com/BornToBeRoot/NETworkManager/issues/new/choose) before you can join the translation team and start translating.

See also the [contributing guidelines](https://github.com/BornToBeRoot/NETworkManager/blob/main/CONTRIBUTING.md) for this project.
68 changes: 68 additions & 0 deletions Website/docs/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
sidebar_position: 1
---

# Introduction

:::note

Documentation is currently migrated... You can find the old documentation [here](https://github.com/BornToBeRoot/NETworkManager/tree/main/docs/Documentation).

:::

## What is NETworkManager?

**NETworkManager is a powerful open source tool for managing networks and troubleshooting network problems!**

Connect and manage remote systems with Remote Desktop, PowerShell, PuTTY, TigerVNC or AWS (Systems Manager) Session Manager. Analyze and troubleshoot your network and systems with features such as the WiFi Analyzer, IP Scanner, Port Scanner, Ping Monitor, Traceroute, DNS lookup or LLDP/CDP capture (and many [more](./Features)) in a unfied interface. Hosts (or networks) can be saved in (encrypted) profiles and used across all features.

![NETworkManager Preview](/img/Preview.gif)

<div>
<p>
<a href="https://github.com/BornToBeroot/NETworkManager/releases" target="_blank">
<img alt="All releases" src="https://img.shields.io/github/downloads/BornToBeroot/NETworkManager/total.svg?style=for-the-badge&logo=github" />
</a>
<a href="https://github.com/BornToBeroot/NETworkManager/releases/latest" target="_blank">
<img alt="Latest release" src="https://img.shields.io/github/downloads/BornToBeroot/NETworkManager/latest/total.svg?style=for-the-badge&logo=github" />
</a>
<a href="https://github.com/BornToBeroot/NETworkManager/releases" target="_blank">
<img alt="Latest pre-release" src="https://img.shields.io/github/downloads-pre/BornToBeroot/NETworkManager/latest/total.svg?label=downloads%40pre-release&style=for-the-badge&logo=github" />
</a>
</p>
<p>
<a href="https://github.com/BornToBeroot/NETworkManager/stargazers" target="_blank">
<img alt="GitHub stars" src="https://img.shields.io/github/stars/BornToBeroot/NETworkManager.svg?style=for-the-badge&logo=github" />
</a>
<a href="https://github.com/BornToBeroot/NETworkManager/network" target="_blank">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/BornToBeroot/NETworkManager.svg?style=for-the-badge&logo=github" />
</a>
</p>
<p>
<a href="https://ci.appveyor.com/project/BornToBeRoot/NETworkManager/branch/main">
<img alt="AppVeyor" src="https://img.shields.io/appveyor/ci/BornToBeRoot/NETworkManager/main.svg?style=for-the-badge&logo=appveyor&&label=main" />
</a>
<a href="https://github.com/BornToBeRoot/NETworkManager/blob/main/LICENSE">
<img alt="AppVeyor" src="https://img.shields.io/github/license/BornToBeroot/NETworkManager.svg?style=for-the-badge&logo=github" />
</a>
</p>
<p>
<a href="https://transifex.com/BornToBeRoot/NETworkManager/">
<img alt="Transifex" src="https://img.shields.io/badge/transifex-translate-green.svg?style=for-the-badge" />
</a>
<a href="https://github.com/BornToBeRoot/NETworkManager/issues/new?labels=Feature-Request&template=Feature_request.md">
<img alt="Feature request" src="https://img.shields.io/badge/github-feature_request-green.svg?style=for-the-badge&logo=github" />
</a>
<a href="https://github.com/BornToBeRoot/NETworkManager/issues/new?labels=Issue&template=Bug_report.md">
<img alt="Bug report" src="https://img.shields.io/badge/github-bug_report-red.svg?style=for-the-badge&logo=github" />
</a>
</p>
</div>

## License

The code is open source and available on [GitHub](https://github.com/BornToBeRoot/NETworkManager) published under the [GNU General Public License v3](https://github.com/BornToBeRoot/NETworkManager/blob/main/LICENSE).

## Code of Conduct

This project has adopted the [code of conduct](https://github.com/BornToBeRoot/NETworkManager/blob/main/CODE_OF_CONDUCT.md) defined by the [Contributor Covenant](https://contributor-covenant.org/).
5 changes: 5 additions & 0 deletions Website/docs/application/arptable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 25
---

# ARP Table
5 changes: 5 additions & 0 deletions Website/docs/application/awssessionmanager.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 12
---

# AWS Session Manager
5 changes: 5 additions & 0 deletions Website/docs/application/bitcalculator.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 21
---

# Bit Calculator
5 changes: 5 additions & 0 deletions Website/docs/application/connections.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 23
---

# Connections
5 changes: 5 additions & 0 deletions Website/docs/application/discoveryprotocol.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 17
---

# Discovery Protocol
5 changes: 5 additions & 0 deletions Website/docs/application/dnslookup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 8
---

# DNS Lookup
5 changes: 5 additions & 0 deletions Website/docs/application/listeners.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 24
---

# Listeners
5 changes: 5 additions & 0 deletions Website/docs/application/lookup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 22
---

# Lookup
5 changes: 5 additions & 0 deletions Website/docs/application/networkinterface.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 2
---

# Network Interface
5 changes: 5 additions & 0 deletions Website/docs/application/pingmonitor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 6
---

# Ping Monitor
5 changes: 5 additions & 0 deletions Website/docs/application/powershell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 10
---

# PowerShell
5 changes: 5 additions & 0 deletions Website/docs/application/putty.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 11
---

# PuTTY
5 changes: 5 additions & 0 deletions Website/docs/application/remotedesktop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 9
---

# Remote Desktop
5 changes: 5 additions & 0 deletions Website/docs/application/snmp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
sidebar_position: 15
---

# SNMP
Loading