Skip to content

Update README.md #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 28, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,17 @@ Unity Web Portal is a PHP application built in top of MariaDB and LDAP which act
1. Composer (`apt install composer` on Ubuntu)
1. PHP Extensions
1. `php-ldap`
2. `php-curl`
3. `php-redis`
4. `php-cli`
5. `php-mysql`
6. `php-pdo`
2. Composer packages
1. `php-curl`
1. `php-redis`
1. `php-cli`
1. `php-mysql`
1. `php-pdo`
1. Composer packages
1. `cd` to this repository
2. Install packages `composer update`
3. Setup config file `config/config.ini` according to your site deployment
4. Setup branding file `config/branding/config.ini` according to your site deployment
5. Point your web server's document root to `webroot` in this repo
1. Install packages `sudo composer update --no-plugins --no-scripts`
1. Deployment:
1. configure the files in `deployment/` according to their respective `README.md` files
1. Point your web server's document root to `webroot` in this repo

The scope of this project ends at being responsible for the LDAP user database. We recommend production deployments to set up scripts which detect changes in LDAP and then perform further actions. For example, a script can be used to create Slurm scheduler accounting roles based on the LDAP information created by this website.

Expand All @@ -46,7 +46,7 @@ The update process is similar to the installation process:

1. Clone the release and follow installation instructions 1 and 2 from above.
2. Copy the following folders from the old installation to the new one:
1. `config`
1. `deployment`
2. `webroot/assets/footer_logos`

We recommend a deployment where each version of the portal is its own clone, then just change a symlink to point to the new version. This way a rollback is much easier.
Expand Down
Loading