Skip to content

Commit 1633565

Browse files
committed
Refresh README and clarify Incus scope
Improve README clarity and accessibility by adding alt text to badge images, tightening the intro, and replacing the one-off install snippet with guidance to use commands from community-scripts.org. The docs now simplify repository layout and maintenance ownership (ct/install mirrored, vm/tools/json maintained here), remove redundant mirror-specific detail, and update wording around Incus responsibilities to reduce confusion.
1 parent f529d7e commit 1633565

1 file changed

Lines changed: 24 additions & 57 deletions

File tree

README.md

Lines changed: 24 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,29 @@
66
The same application scripts as Proxmox VE, running on the Incus backend</p>
77

88
<p>
9-
<a href="https://community-scripts.org"><img src="https://img.shields.io/badge/Website-community--scripts.org-4c9b3f?style=flat-square" /></a>
10-
<a href="https://discord.gg/3AnUqsXnmK"><img src="https://img.shields.io/badge/Discord-Join_us-7289da?style=flat-square&logo=discord&logoColor=white" /></a>
11-
<a href="https://github.com/community-scripts/Incus/stargazers"><img src="https://img.shields.io/github/stars/community-scripts/Incus?style=flat-square&label=Stars&color=f5a623" /></a>
12-
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=flat-square" /></a>
9+
<a href="https://community-scripts.org"><img src="https://img.shields.io/badge/Website-community--scripts.org-4c9b3f?style=flat-square" alt="Website" /></a>
10+
<a href="https://discord.gg/3AnUqsXnmK"><img src="https://img.shields.io/badge/Discord-Join_us-7289da?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
11+
<a href="https://github.com/community-scripts/Incus/stargazers"><img src="https://img.shields.io/github/stars/community-scripts/Incus?style=flat-square&label=Stars&color=f5a623" alt="Stars" /></a>
12+
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=flat-square" alt="License" /></a>
1313
</p>
1414
</div>
1515

1616
---
1717

1818
## What is this?
1919

20-
**Community scripts for Incus hosts.** If you run Incus, this is the repository
21-
you point your install commands at — you should never have to paste a URL with
20+
**Community scripts for Incus hosts.** If you run Incus, point your install
21+
commands at this repository — you should never have to paste a URL with
2222
`ProxmoxVE` in it.
2323

24-
```bash
25-
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/Incus/main/ct/debian.sh)"
26-
```
24+
A script only describes *what* to install. Creating the container is the job of
25+
the shared engine in [core](https://github.com/community-scripts/core), which
26+
detects an Incus host and drives the `incus` CLI. Ready-made commands for every
27+
application are on [community-scripts.org](https://community-scripts.org).
2728

28-
Run that in your Incus host shell. The script picks up the shared engine from
29-
[core](https://github.com/community-scripts/core), which detects that it is on
30-
an Incus host and creates the container with the `incus` CLI.
29+
---
3130

32-
### Built on Incus
31+
## Built on Incus
3332

3433
[Incus](https://github.com/lxc/incus) is a system container and virtual machine
3534
manager from the [LinuxContainers](https://linuxcontainers.org/) project. Every
@@ -49,51 +48,19 @@ LinuxContainers or the Incus maintainers.
4948

5049
---
5150

52-
## This is a mirror, not a fork
53-
54-
The application scripts are **platform-agnostic**. A `ct/` script describes what
55-
to install, not how to create a container — that part lives in the engine, which
56-
has one backend per platform. So the scripts here are the same files as in
57-
[ProxmoxVE](https://github.com/community-scripts/ProxmoxVE), with one difference:
58-
the bootstrap line loads the engine from core instead of ProxmoxVE's own `misc/`.
59-
60-
```
61-
ProxmoxVE/ct/debian.sh → source .../ProxmoxVE/main/misc/build.func (monolith, PVE only)
62-
Incus/ct/debian.sh → source .../core/main/core/build.func (detects the host)
63-
```
64-
65-
They are kept in sync automatically — see [`.github/workflows/sync-scripts.yml`](.github/workflows/sync-scripts.yml).
66-
67-
**Do not fix application bugs here.** A fix made in this repository is overwritten
68-
by the next sync. Send it to ProxmoxVE (or ProxmoxVED for new scripts) and it
69-
arrives here on its own.
70-
71-
---
72-
7351
## Layout
7452

7553
| Folder | Contents | Source |
7654
| ------ | -------- | ------ |
77-
| `ct/` | 565 application scripts | mirrored from ProxmoxVE |
78-
| `install/` | 552 in-container install scripts | mirrored from ProxmoxVE |
79-
| `vm/` | 14 virtual machine scripts | maintained here — Incus VMs, not a mirror |
80-
|| ASCII banners | served from [core](https://github.com/community-scripts/core), generated for all repos at once |
81-
| `tools/incus/` | Incus host management | planned, currently empty |
82-
| `json/` | Incus-only metadata | planned, currently empty |
83-
84-
Folder names deliberately match ProxmoxVE. The engine resolves
85-
`install/<app>-install.sh` by that exact path, so renaming it would mean making
86-
the engine's paths platform-dependent — new divergence for a cosmetic gain.
87-
88-
### What is not here, and why
89-
90-
| Not mirrored | Reason |
91-
| ------------ | ------ |
92-
| ProxmoxVE's `vm/` | Those scripts call `qm` and `pvesm` directly and are not portable. Incus VMs are built through `incus launch --vm` instead, so `vm/` here is written for this repository rather than mirrored. |
93-
| `turnkey/` | TurnKey Linux templates are a Proxmox VE feature. |
94-
| `tools/pve/` | Host management through `pve*` binaries. The Incus counterpart is `tools/incus/`. |
95-
| `misc/` | The old in-repo engine. It lives in [core](https://github.com/community-scripts/core) now. |
96-
| `ct/headers/` | Headers are generated artifacts derived from each script's `APP=` line, and identical on both platforms. core generates them once for every script repo. |
55+
| `ct/` | Application scripts | mirrored from [ProxmoxVE](https://github.com/community-scripts/ProxmoxVE) |
56+
| `install/` | In-container install scripts | mirrored from ProxmoxVE |
57+
| `vm/` | Virtual machine scripts | maintained here |
58+
| `tools/incus/` | Incus host management | maintained here |
59+
| `json/` | Incus-only metadata | maintained here |
60+
61+
ASCII banners are not in this repository. They are generated from each script's
62+
`APP=` line into [core](https://github.com/community-scripts/core), which serves
63+
them to every script repo at once.
9764

9865
---
9966

@@ -121,7 +88,7 @@ for storage pools, networking, GPU passthrough and the update path.
12188
| [core](https://github.com/community-scripts/core) | The engine — one codebase, one backend per platform |
12289
| [ProxmoxVE](https://github.com/community-scripts/ProxmoxVE) | Canonical application scripts, plus `tools/pve/`, `vm/`, `turnkey/` |
12390
| [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) | Where new scripts are tested first |
124-
| **Incus** (this repo) | The same scripts, pointed at core, plus Incus host tooling |
91+
| **Incus** (this repo) | The same scripts, pointed at core, plus Incus VMs and host tooling |
12592

12693
---
12794

@@ -154,13 +121,13 @@ Put core elsewhere with `COMMUNITY_SCRIPTS_CORE_DIR`.
154121
| Fix an application script | [ProxmoxVE](https://github.com/community-scripts/ProxmoxVE) — fixes made here are overwritten by the sync |
155122
| Add a new application script | [ProxmoxVED](https://github.com/community-scripts/ProxmoxVED) |
156123
| Change how containers are built | [core](https://github.com/community-scripts/core) |
157-
| Add or fix an Incus VM script | Here, in `vm/` — these are not mirrored |
124+
| Add or fix an Incus VM script | Here, in `vm/` |
158125
| Add Incus host tooling | Here, in `tools/incus/` |
159126
| Report an Incus-specific bug | [Issues](https://github.com/community-scripts/Incus/issues) — say whether it also reproduces on Proxmox VE |
160127
| Ask a question | [Discord](https://discord.gg/3AnUqsXnmK) |
161128

162129
A bug that reproduces on both platforms is an application or engine bug, not an
163-
Incus one. Only the Incus backend, `vm/` and `tools/incus/` are maintained here.
130+
Incus one.
164131

165132
---
166133

0 commit comments

Comments
 (0)