docs: add badges, troubleshooting and changelog

This commit is contained in:
2026-05-31 13:43:44 +03:00
parent ae84678f60
commit 10813528d5
3 changed files with 100 additions and 0 deletions

View File

@@ -1,5 +1,9 @@
# AstraDeploy
[![License](https://img.shields.io/badge/License-MIT-green)](LICENSE)
[![Bash](https://img.shields.io/badge/Bash-4%2B-brightgreen)](https://www.gnu.org/software/bash/)
[![Version](https://img.shields.io/badge/Version-v0.1.0-blue)](README.md)
`AstraDeploy` is a Bash installer for Minecraft server cores (Java and Bedrock) with:
- interactive beginner mode (`--easy`);
@@ -158,6 +162,28 @@ sudo bash install.sh \
- `--locale en|ru` or `--lang en|ru`
- script also reads `LANGUAGE` / `LANG` environment fallback
## Troubleshooting
- **Port is already in use**
- Find the process by `lsof -i:<port>` and stop it, or choose a different `--port`.
- For non-standard setups, set `--port` to an available TCP/UDP port depending on the core.
- **Installer stops on missing dependencies or package errors**
- Re-run with `--debug` to inspect detected package manager and failed command.
- Ensure the host has internet access and package repositories are reachable.
- **Permission denied while creating/changing files**
- Run via `sudo`/`root` for privileged operations.
- Verify `--user` exists and has write permissions on `--dir`.
- **Firewall was not configured automatically**
- Installer prints a manual notice when `ufw`/`firewalld` is unavailable.
- Open ports manually in your system firewall before continuing.
- **Report callback is not sent**
- Callback failures are non-blocking.
- Validate URL/token and retry install with corrected `--report-url` and `--report-token`.
## Safety notes
- Script is designed with guardrails but still executes privileged operations (packages/services/firewall/files).
@@ -175,3 +201,6 @@ See [`LICENSE`](LICENSE) for the full text and disclaimers.
sudo bash install.sh --version
```
## Changelog
See [`CHANGELOG.md`](CHANGELOG.md).