Skip to content
Closed
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
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## core
- initialize
- [initialize_env](./initialize_env.md) — Detect and expose common environment variables for other config-v2 modules
- [list_options](./list_options.md) — Show available option groups and their usage for configng-v2 modules.
- [trace](./trace.md) — Lightweight timing and trace message utility for Configng V2 modules.
- [submenu](./submenu.md) — Parse a list_options message and present commands as an interactive menu.
Expand All @@ -23,6 +24,9 @@
## software
- management
- [cockpit](./cockpit.md) — Web-based administrative interface for managing Linux servers.
- [webmin](./webmin.md) — Webmin setup and service control.
- mediaserver
- [plexmediaserver](./plexmediaserver.md) — SDK/development tool to install, remove, or check the status of Plex Media Server via the official repository. Not intended for production use unless otherwise secured and configured.

## system
- kernel
Expand Down
22 changes: 22 additions & 0 deletions docs/initialize_env.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# initialize_env
Detect and expose common environment variables for other config-v2 modules

## About
Provides helpers to detect system and project paths (BIN_ROOT, LIB_ROOT, WEB_ROOT, etc.), OS/release metadata (sourced from /etc/os-release and /etc/armbian-release), and runtime info (kernel, default network adapter, local IP/subnet). Intended to be sourced by callers; includes helpers to print or emit export lines suitable for eval. Keep side effects opt-in (INITIALIZE_AUTO) to avoid surprising behavior on source.

## Usage
~~~bash
Usage: initialize_env [help|-h|--help]

About:
The 'initialize_env' module provides environment detection utilities.

Commands:
help - Show this help message.

Notes:
- To set variables in the current shell: source this file and call _initialize_env_vars
- When executed, this file's test entrypoint verifies the environment and prints variables.
~~~

- Autogenerated from `./src/core/initialize/initialize_env.conf` and `./src/core/initialize/initialize_env.sh`
106 changes: 0 additions & 106 deletions docs/modules_metadata.json

This file was deleted.

33 changes: 33 additions & 0 deletions docs/plexmediaserver.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# plexmediaserver
SDK/development tool to install, remove, or check the status of Plex Media Server via the official repository. Not intended for production use unless otherwise secured and configured.

## About
This module enables quick setup, removal, and status checks for Plex Media Server on Armbian-based systems as part of SDK or workflow automation. It manages the official repository, GPG keys, and installation process. The module is best suited for development, testing, or controlled environments. Production usage is not recommended unless you have reviewed security and configuration.

## Usage
~~~bash
Usage: plexmediaserver <command> [options]

Commands:
install Install the Plex Media Server.
remove Remove the Plex Media Server.
status Check if the Plex Media Server is installed.
help Show this help message.

Examples:

plexmediaserver install
plexmediaserver remove
plexmediaserver status
plexmediaserver help

Notes:
- This script is intended for use with Armbian Config V2.
- It installs the Plex Media Server from the official repository.
- The server will be available on port 32400 by default.
- Ensure that you have the necessary permissions to run this script.
- Use 'sudo' if required to execute commands that need elevated privileges.
- Keep this help message up to date if commands change.
~~~

- Autogenerated from `./src/software/management/plexmediaserver.conf` and `./src/software/management/plexmediaserver.sh`
42 changes: 42 additions & 0 deletions docs/webmin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# webmin
Webmin setup and service control.

## About
Provides installation removal service management and status checks for the Webmin web-based system administration tool. Supports enabling/disabling on boot and verifying service state.

## Usage
~~~bash
Usage: webmin <command>

Commands:
help - Show this help message
install - Install Webmin
remove - Remove Webmin
start - Start the Webmin service
stop - Stop the Webmin service
enable - Enable Webmin to start on boot
disable - Disable Webmin from starting on boot
status - Show the status of the Webmin service
check - Perform a basic check of Webmin

Examples:
# Install Webmin
webmin install

# Start Webmin
webmin start

# Check Webmin status
webmin status

Notes:
- Maintainer: @Tearran
- Author: @Tearran
- Status: Active
- Documentation: https://webmin.com/docs/
- Port: 10000
- Supported Architectures: x86-64 arm64 armhf
- Group: Management
~~~

- Autogenerated from `./src/software/management/webmin.conf` and `./src/software/management/webmin.sh`
47 changes: 47 additions & 0 deletions staging/promote_staged_module.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# promote_staged_module - Configng V2 metadata

[promote_staged_module]
# Main feature provided by this module (usually the same as the module name).
feature=promote_staged_module

# Short, single-line summary describing what this module does.
description=

# Longer description with more details about the module's features or usage.
extend_desc=

# Comma-separated list of commands supported by this module (e.g., help,status,reload).
options=

# Main category this module belongs to. Must be one of: network, system, software, locales.
parent=

# Group or tag for this module. See docs/readme.md (group index) for options.
# If none fit, suggest a new group in your pull request.
group=

# Contributor's GitHub username (use @username).
contributor=

# Comma-separated list of supported CPU architectures.
arch=

# Comma-separated list of supported operating systems.
require_os=

# What kernel are you using? (minimum required version, e.g., 5.15+)
require_kernel=

# Comma-separated list of network ports used by this module (e.g., 8080,8443). Use 'false' if not applicable.
port=false

# Comma-separated list of functions in this module (all functions except the main feature).
# NOTE: You must include the help message function _about_promote_staged_module; validation will fail if it is missing.
helpers=

# List each command and its description below.
# Example:
# show=Display the current configuration
[options]
help=Show help for this module

Loading