webcron
/
webcron
1
0
Fork 0
Code Issues 6 Pull Requests Projects 1 Releases 6 Wiki Activity

Updated readme

This commit is contained in:
Jeroen De Meerleer 2022-09-07 12:09:49 +02:00
parent dd18843c12
commit abc79023bd
Signed by: JeroenED
GPG Key ID: 28CCCB8F62BFADD6
1 changed files with 29 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -3,22 +3,9 @@
Webcron management is an easy-to-use interface to manage cronjobs running on a publicly available http-location. Webcron management is an easy-to-use interface to manage cronjobs running on a publicly available http-location.
### Known bugs ## Building
* Datepicker ([Tempus dominus v6](https://getdatepicker.com/)) is currently alpha-quality software. Altough [the dev states it is usable](https://jonathanpeterson.com/posts/state-of-my-datetime-picker-part-2.html)
## Deploying
### Requirements for web-server
* php <= 8.1
* ext-openssl
* ext-intl
* ext-pcntl (highly recommended)
* MariaDB
* Ability to change the webroot directory
* Ability to run a script as daemon (eg. supervisor or systemd units)
### Requirements for build-server ### Requirements for build-server
* php <= 8.1 (incl composer <= 2) * php <= 8.1 (incl composer <= 2, ext-pcntl, ext-openssl, ext-intl)
* NodeJS <= 16.0 (incl. npm <= 8) * NodeJS <= 16.0 (incl. npm <= 8)
### Building ### Building
@ -26,32 +13,46 @@ Please run following command on the build server
```shell ```shell
$ composer install --no-dev --optimize-autoloader $ composer install --no-dev --optimize-autoloader
$ npm install $ npm install
$ npx build prod $ npm run build
$ rm -rf node_modules # Node modules are only required for building $ rm -rf node_modules # Node modules are only required for building
``` ```
### Configuration ## Installation
All configuration can be found in .env.sample. Please copy this to file to .env and change its values ### Requirements
* php <= 8.1
* ext-openssl
* ext-intl
* ext-pcntl (highly recommended)
* MariaDB
* SSH-access to the server
* Ability to change the webroot directory
* Ability to run a script as daemon (eg. supervisor or systemd units)
### Installation ### Installation
First follow the build and configuration instructions. If you don't follow them correctly Webcron Management won't work correctly 1. Create a build yourself or download the build from the releases page
1. Create your database and import the storage/database.sql file into the database 2. Upload the build to the webserver.
2. Create a first user by inserting a first record to the users table (Password is hashed using the HASHING_METHOD in your .env)
3. Set up your webhosting to use the `/public` directory as web root 3. Set up your webhosting to use the `/public` directory as web root
4. Upload the repository to the webserver 4. Create the .env file by copying .env.sample to .env and change the values
5. Set up the daemon script using systemd, supervisord or similar system 5. Run `php bin/console doctrine:migrations:migrate` to create or migrate the database
* If this is not possible running the daemon using a cronjob is still possible using below gist (Not recommended) 6. Create a first user by running `php bin/console webcron:user add`
7. Set up the daemon script using systemd, supervisord or similar system
If this is not possible running the daemon using a cronjob is still possible using below gist (Not recommended)
```shell ```shell
0 * * * * cd /path/to/webcron/ && php webcron daemon --time-limit=3600 > /dev/null 1&>2 0 * * * * cd /path/to/webcron/ && php webcron daemon --time-limit=3600 > /dev/null 1&>2
``` ```
The webcron interface should now work as expected. ## Upgrading
### Requirements
Same requirements and deploying
### Procedure
1. Remove all files except .env from the webserver
2. Upload the new build to the webserver
3. Run `php bin/console doctrine:migrations:migrate` to migrate the database
## Common pitfalls ## Common pitfalls
### Cronjobs are not running
Did you edit the crontab?
### I can't do an automatic system upgrade! ### I can't do an automatic system upgrade!
Doing a system upgrade requires sudo which has a certain number security measurements. To enable running anything with sudo (eg. `sudo apt dist-upgrade -y`) the user needs to be able to run sudo without tty and password. Doing a system upgrade requires sudo which has a certain number security measurements. To enable running anything with sudo (eg. `sudo apt dist-upgrade -y`) the user needs to be able to run sudo without tty and password.