Upload files to "/"

README.md

@@ -0,0 +1,47 @@
+# Wakeupper for Proxmox Backup Server
+
+![CryptoFox](https://data.shupogaki.org/assets/serika-blue-archive.gif)
+
+Program for running scheduled Proxmox Backup Server syncs and also waking up the iDRAC, and possibly ILOM, servers.
+
+It can:
+
+* Power on a PBS server through iDRAC/IPMI
+* Wait for the server to become reachable
+* Connect to PBS over SSH
+* Create a sync job if needed and start it
+* Wait for PBS tasks to finish
+* Shut down the PBS server when finished
+
+Designed to run in Docker or Kubernetes/CronJob.
+
+## Environment variables
+
+| Variable               | Description                         | Default                     |
+| ---------------------- | ----------------------------------- | --------------------------- |
+| `IDRAC`                | iDRAC hostname/IP                   | required                    |
+| `IDRAC_USR`            | iDRAC username                      | required                    |
+| `IDRAC_PWD`            | iDRAC password                      | required                    |
+| `HOST`                 | PBS hostname/IP                     | required                    |
+| `HOST_SSH_PORT`        | PBS SSH port                        | required                    |
+| `HOST_USR`             | SSH username                        | `root`                      |
+| `HOST_USR_PWD`         | SSH password                        | optional                    |
+| `HOST_USR_SSHKEY`      | SSH private key                     | optional                    |
+| `HOST_USR_SSHKEY_PASS` | SSH key passphrase                  | optional                    |
+| `LOCAL_DATASTORE`      | Local PBS datastore                 | required                    |
+| `REMOTE_DATASTORE`     | Remote PBS datastore                | required                    |
+| `REMOTE_PBS`           | Remote PBS hostname/address         | required                    |
+| `SYNC_DIR`             | Sync direction: `push` or `pull`    | `push`                      |
+| `PBS_RATE_OUT`         | Push bandwidth limit                | optional                    |
+| `PBS_RATE_IN`          | Pull bandwidth limit                | optional                    |
+| `PBS_TASK_LIMIT`       | Number of PBS tasks to inspect      | `50`                        |
+| `PBS_MAX_RUNTIME_MIN`  | Maximum task runtime                | `180`                       |
+| `PBS_MAX_SHUT_MIN`     | Time allowed for shutdown           | `10`                        |
+| `AUTO_ADD_NAME`        | Automatically created sync-job name | `autoBackupScript_one-shot` |
+
+Example Kubernetes configuration is available in `manifest.yaml`, including Secret/ConfigMap values and a scheduled CronJob.
+
+
+
+
+