Add installation/summery.md

This commit is contained in:
Ghassan Yusuf 2025-09-21 23:24:49 +03:00
parent 2e89267b52
commit 77cce00c8f

40
installation/summery.md Normal file
View File

@ -0,0 +1,40 @@
### What the curl command does (when you run `curl URL | bash`):
```
curl -sSL https://git.innovator.bh/TAKEONE/proxmox-lxc-dotnet-postgres-api/raw/branch/main/install.sh | bash
```
- Downloads your installation script (`install.sh`) from your Git repository.
- Executes the script immediately in the shell (`bash`).
- The script itself will:
- Update system packages.
- Install prerequisites, .NET 8 runtime and SDK.
- Install PostgreSQL and start its service.
- Create PostgreSQL user (`api`) and database (`apidatabase`) with password `abcd1234`.
- Create and prepare the `/opt/api` directory.
- Create a systemd service unit to run your .NET Web API DLL.
- Enable and start the systemd service automatically.
***
### What remains for you to do manually:
- Copy your published .NET Web API application files (DLL, `appsettings.json`, etc.) into the directory `/opt/api`. The script pauses and waits for you to do this before continuing.
- Optionally, customize the script or paths if your setup differs.
- Test your API endpoints with curl or Postman after service starts.
- Optionally configure reverse proxy, firewalls, or SSL certificates if needed.
***
### Summary Table
| Task | Done by curl script | Done by user |
|------------------------------------|---------------------|------------------------------|
| System package update | ✔ | |
| Install .NET 8 runtime and SDK | ✔ | |
| Install PostgreSQL | ✔ | |
| Create PostgreSQL user & database | ✔ | |
| Create application directory | ✔ | |
| Copy API published files | | ✔ |
| Create systemd service and start | ✔ | |
| Test API endpoints | | ✔ |