docs(readme): remove applications, tools, project structure, and release sections
This commit is contained in:
@@ -33,60 +33,6 @@ lxs version # Show version
|
|||||||
lxs help # Show help
|
lxs help # Show help
|
||||||
```
|
```
|
||||||
|
|
||||||
### Applications
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
|---|---|
|
|
||||||
| `lxs install coolify` | Self-hosted PaaS |
|
|
||||||
| `lxs install pterodactyl` | Game server management panel |
|
|
||||||
| `lxs install uptime-kuma` | Monitoring tool |
|
|
||||||
| `lxs install cloudpanel` | Web hosting control panel |
|
|
||||||
| `lxs install proxmox` | Proxmox VE management tools |
|
|
||||||
|
|
||||||
### Tools
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
|---|---|
|
|
||||||
| `lxs tool system` | System monitoring and diagnostics |
|
|
||||||
| `lxs tool benchmark` | Server benchmark (CPU / RAM / disk / network) |
|
|
||||||
| `lxs tool harden` | Baseline hardening: UFW + fail2ban + SSH key-only + unattended-upgrades |
|
|
||||||
| `lxs tool root-password` | Change the root password (interactive or generated) |
|
|
||||||
| `lxs tool update` | Update the server (apt update + upgrade + autoremove + autoclean) |
|
|
||||||
| `lxs tool root-ssh-login` | Enable or disable root login over SSH with a password |
|
|
||||||
| `lxs tool welcome` | View, edit, or reset the SSH welcome message (MOTD) |
|
|
||||||
|
|
||||||
## Project structure
|
|
||||||
|
|
||||||
```
|
|
||||||
lxs/
|
|
||||||
├── lxs.sh # Main entrypoint (menu + CLI dispatcher)
|
|
||||||
├── VERSION # Single source of truth for the version (bump on every release)
|
|
||||||
├── lib/
|
|
||||||
│ └── common.sh # Shared helpers (colors, loggers, spinner)
|
|
||||||
├── apps/ # Application installers
|
|
||||||
│ ├── index.sh # Interactive menu listing the apps below
|
|
||||||
│ ├── coolify.sh
|
|
||||||
│ ├── pterodactyl.sh
|
|
||||||
│ ├── uptime-kuma.sh
|
|
||||||
│ ├── cloudpanel.sh
|
|
||||||
│ └── proxmox.sh
|
|
||||||
└── tools/ # System tools
|
|
||||||
├── index.sh # Interactive menu listing the tools below
|
|
||||||
├── system-infos.sh
|
|
||||||
├── server-benchmark.sh
|
|
||||||
├── harden.sh
|
|
||||||
├── root-password.sh
|
|
||||||
├── update-server.sh
|
|
||||||
├── root-ssh-login.sh
|
|
||||||
└── welcome-message.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
After `lxs setup`, the full tree lives in `/usr/local/share/lxs/` and sub-scripts execute from disk. If `lxs.sh` is run without being installed (the one-liner mode), it falls back to downloading sub-scripts on demand.
|
|
||||||
|
|
||||||
### Releasing a new version
|
|
||||||
|
|
||||||
Bump only the [VERSION](VERSION) file — `lxs.sh` reads it at startup. Installed clients also fetch this file (cached 24 h in `~/.cache/lxs/`) to detect updates. In one-shot mode (`curl … | bash`) the file isn't on disk next to the script, so `lxs version` reports `dev`.
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
|
|
||||||
- Debian or Ubuntu (other distros may work but are not tested)
|
- Debian or Ubuntu (other distros may work but are not tested)
|
||||||
|
|||||||
Reference in New Issue
Block a user