Remzona54/Remnawave_Panel
1
0
Fork 0
mirror of https://github.com/remnawave/panel.git synced 2026-08-27 04:07:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: avoid stale Terraform provider metadata

Browse source
This commit is contained in:
Fedor Batonogov 2026-08-10 11:04:57 +03:00
parent 4780f3f05f
commit 09ef2000a5
2 changed files with 13 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/awesome-remnawave.mdx
View file

@ -392,7 +392,7 @@ import TerraformProviderRemnawaveGuide from '/docs/awesome-remnawave/\_install-g
<ProjectCard
id="terraform-provider-remnawave"
title="Terraform Provider for Remnawave"
description="Community Terraform provider for managing Remnawave users, nodes, hosts, squads, billing, subscriptions, templates, panel settings, and more as version-controlled infrastructure. Includes 26 resources, 25 data sources, and acceptance tests against Remnawave 2.7.4–3.2.2."
description="Community Terraform provider for managing Remnawave users, nodes, hosts, squads, billing, subscriptions, templates, panel settings, and more as version-controlled infrastructure, with import support and acceptance tests against real Remnawave backends."
author="batonogov"
authorLink="https://github.com/batonogov"
image="/awesome/terraform-provider-remnawave.webp"

20
docs/awesome-remnawave/_install-guides/terraform-provider-remnawave.md
View file

@ -1,10 +1,9 @@
### What it manages
- **26 resources** for users, nodes, hosts, squads, config profiles, subscriptions, billing, panel settings, API tokens, metadata, HWID devices, snippets, passkeys, and node plugins
- **25 data sources** for inventory, system and bandwidth statistics, subscriptions, connection keys, request history, passkeys, and HWID analytics
- **Resources and data sources** for users, nodes, hosts, squads, config profiles, subscriptions, billing, panel settings, API tokens, metadata, HWID devices, snippets, passkeys, and node plugins
- **Import support** for bringing existing panel objects under Terraform management
- **API token or username/password authentication**, with automatic JWT refresh for login-based sessions
- **Remnawave 2.7.4–3.2.2 compatibility**, acceptance-tested against real, digest-pinned 2.7.4, 2.8.1, 3.0.0, 3.1.0, and 3.2.2 backends
- **Node IP management** on Remnawave 3.2.2 and newer
- **Acceptance-tested compatibility** across multiple real, digest-pinned Remnawave backends; see the [current compatibility matrix](https://github.com/batonogov/terraform-provider-remnawave#compatibility)
- **Terraform Registry documentation** indexed by [Context7](https://context7.com/batonogov/terraform-provider-remnawave) for AI coding assistants
### Quick start
@ -16,17 +15,21 @@ terraform {
required_providers {
remnawave = {
source = "batonogov/remnawave"
version = "~> 1.4.0"
version = ">= 1.4.0, < 2.0.0"
}
}
}
```
Keep credentials out of configuration by using environment variables:
Keep credentials out of configuration and shell history. For this tutorial,
use a token with `system:read`, `users:read`, and `users:write` scopes; a
wildcard token also works.
```bash
export REMNAWAVE_ENDPOINT="https://panel.example.com"
export REMNAWAVE_API_TOKEN="..."
read -rsp "Remnawave API token: " REMNAWAVE_API_TOKEN
export REMNAWAVE_API_TOKEN
printf '\n'
```
Create a Remnawave user as code:
@ -34,7 +37,7 @@ Create a Remnawave user as code:
```hcl
resource "remnawave_user" "example" {
username = "john-doe"
expire_at = "2027-01-01T00:00:00.000Z"
expire_at = "2030-01-01T00:00:00.000Z"
traffic_limit_bytes = 10737418240
traffic_limit_strategy = "MONTH"
description = "Managed by Terraform"
@ -47,6 +50,7 @@ Then initialize and review the plan before applying it:
terraform init
terraform plan
terraform apply
unset REMNAWAVE_API_TOKEN
```
See the complete resource and data-source reference in the [Terraform Registry](https://registry.terraform.io/providers/batonogov/remnawave/latest).