You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-4Lines changed: 34 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,15 +22,45 @@ Unity Web Portal is a PHP application built in top of MariaDB and LDAP which act
22
22
1. Composer (`apt install composer` on Ubuntu)
23
23
1. PHP Extensions
24
24
1.`php-ldap`
25
-
1. Composer packages
25
+
2.`php-curl`
26
+
2. Composer packages
26
27
1.`cd` to this repository
27
-
1. Install packages `composer update`
28
-
1. Setup config file `config/config.ini` according to your site deployment
29
-
1. Point your web server's document root to `webroot` in this repo
28
+
2. Install packages `composer update`
29
+
3. Setup config file `config/config.ini` according to your site deployment
30
+
4. Setup branding file `config/branding/config.ini` according to your site deployment
31
+
5. Point your web server's document root to `webroot` in this repo
30
32
31
33
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.
32
34
33
35
## Web Server Setup
34
36
External to this codebase, you must configure authentication using your web server. You must retrict the following:
35
37
*`/panel` - users who are signed in
36
38
*`/admin` - admins who are signed in
39
+
40
+
## Updating
41
+
The update process is similar to the installation process:
42
+
43
+
1. Clone the release and follow installation instructions 1 and 2 from above.
44
+
2. Copy the following folders from the old installation to the new one:
45
+
1.`config`
46
+
2.`webroot/res/footer_logos`
47
+
48
+
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.
49
+
50
+
Example folder structure, where `->` indicates a symlink:
51
+
```
52
+
unity-web-portal
53
+
unity-web-portal -> unity-web-portal-1.1.0
54
+
unity-web-portal-1.0.0-RC1
55
+
unity-web-portal-1.0.0-RC2
56
+
unity-web-portal-1.1.0
57
+
```
58
+
59
+
Below you will find specific instructions for moving between version:
60
+
61
+
### 1.0.0-RC2 > 1.1.0
62
+
63
+
1.`config/branding/config.ini.default` has some new fields that will need to be overriden by the site config if needed:
0 commit comments