Project Home Page: https://www.k5n.us/webcalendar/
Project Owner: Craig Knudsen, [email protected]
Documentation:
- System Administrator's Guide (Installation instructions, FAQ)
- Upgrading Instructions
- License: GPLv2
- Online Demo at SF
Developer Resources:
After unzipping your files (or transferring the files to your hosting provider, you will need to go to the web-based install script. If your files are installed in a "webcalendar" folder under your parent web server document root, you can access the script by going to:
https://yourserverhere/webcalendar/
(Obviously, put the correct server name in above.) The toplevel URL will automatically redirect to the installation wizard.
Alternatively, there is a headless installation/update script you can run from the shell:
php webcalendar/install/headless.phpYou must create includes/settings.php yourself before running the headless
install script.
You can use a prebuilt WebCalendar image rather than building it yourself locally.
You will need to shell into the MariaDb container to grant access.
Because we also need a database, we use a local network with WebCalendar
and MariaDb running that is setup with the docker-compose command.
- Start the containers:
docker-compose -f docker/docker-compose-php8.yml up - In order to grant the proper permissions inside of MariaDb, you
will need to run a few MySQL commands. First shell into the mariadb
container:
docker-compose -f docker/docker-compose-php8.yml exec db /bin/sh - Start up the db client:
/bin/mariadb -p(the password will be "Webcalendar.1" as specified in the `docker-compose-php8.yml' file. You can change it to make your dev environment more secure (before you build the containers in step above). - Run the following db commands:
GRANT ALL PRIVILEGES ON *.* TO webcalendar_php8@localhost IDENTIFIED BY 'Webcalendar.1' WITH GRANT OPTION; FLUSH PRIVILEGES; QUIT - Start up your web browser and go to: http://localhost:8080/.
- Follow the guided web-based setup and choose "mysqli" as the database type. Be sure to use the same MariaDb credentials specified above (Password WebCalendar.1 and Database Name webcalendar_php8.)
You can setup a docker environment with PHP 8.1 and MariaDb with a few steps. This docker setup differs from the normal WebCalendar docker image in that the local WebCalendar files are mounted into the container so that changes to your local filesystem will also apply to the WebCalanedar files in the container.
- Build the docker container with
docker-compose -f docker/docker-compose-php8-dev.yml build - Start the containers with
docker-compose -f docker/docker-compose-php8-dev.yml up - In order to grant the proper permissions inside of MariaDb, you
will need to run a few MySQL commands. First shell into the mariadb
container:
docker-compose -f docker/docker-compose-php8-dev.yml exec db /bin/sh - Start up the db client:
/bin/mariadb -p(the password will be "Webcalendar.1" as specified in the `docker-compose-php8-dev.yml' file. You can change it to make your dev environment more secure (before you build the containers in step above). - Run the following db commands:
GRANT ALL PRIVILEGES ON *.* TO webcalendar_php8@localhost IDENTIFIED BY 'Webcalendar.1' WITH GRANT OPTION; FLUSH PRIVILEGES; QUIT - Start up your web browser and go to: http://localhost:8080/.
- Follow the guided web-based setup and choose "mysqli" as the database type. Be sure to use the same MariaDb credentials specified above (Password WebCalendar.1 and Database Name webcalendar_php8.)
You can setup a docker environment with PHP 7.4 and MariaDb with a few steps.
- Build the docker container with
docker-compose -f docker-compose-php7.yml build - Start the containers with
docker-compose -f docker-compose-php7.yml up - In order to grant the proper permissions inside of MariaDb, you
will need to run a few MySQL commands. First shell into the mariadb
container:
docker-compose exec db /bin/sh - Start up the db client:
/bin/mariadb -p(the password will be "Webcalendar.1" as specified in the `docker-compose-php7.yml' file. You can change it to make your dev environment more secure (before you build the containers in step above). - Run the following db commands:
GRANT ALL PRIVILEGES ON *.* TO webcalendar@localhost IDENTIFIED BY 'Webcalendar.1' WITH GRANT OPTION; FLUSH PRIVILEGES; QUIT - Start up your web browser and go to: http://localhost:8080/.
- Follow the guided web-based setup and choose "mysqli" as the database type. Be sure to use the same MariaDb credentials specified above (Password WebCalendar.1 and Database Name webcalendar.)
Web Calendar can be configured to pull user and configuration data from an external application. This allows tighter integration when using Web Calendar alongside your own website or application.
The user integration is accomplished by creating a "bridge" script in the includes directory, for example,
includes/user-app-myapp.php. There are several functions you will need to define in this script. See the
built-in integrations for Joomla
and LDAP as examples for the interface
you'll need to implement.
Once the script is created, add the following line to includes/settings.php:
user_inc: user-app-myapp.php
The process is much the same for external configs. Create a script such as includes/config-app-myapp.php and define
a single function in that script called do_external_configs. This function receives an associative array of all
the settings defined in includes/settings.php, and should return a new associated array that overrides those settings.
Then, simply add this line to includes/settings.php:
config_inc: config-app-myapp.php
External configs will allow your application to supply, for example, database credentials to Web Calendar, rather than these needing to be stored in plain text in the webcalendar directory.