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: HEROKU.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Click the Heroku button and follow the instructions below:
17
17
*`canvas` if you are using the Canvas LMS.
18
18
*`d2l` if you are using the D2l Brightspace LMS.
19
19
5. Fill out the `BASE_URL` field with `https://yourapp.herokuapp.com`. (Replace 'yourapp' with the name you gave in step 1.2.)
20
-
6. Fill out the `JWK_BASE_URL` field with the URL to your LMS. The default value works for instructure hosted instances of Canvas, but will need to be modified according to the LMS and host.
20
+
6. Fill out the `JWK_BASE_URL` field with the URL to your LMS. The default value works for instructure hosted instances of Canvas, but will need to be modified if your JWK configuration is hosted at a different domain than `iss`.
21
21
7. Click the Deploy button and wait for the process to complete.
Copy file name to clipboardExpand all lines: INSTALL.md
+45-16Lines changed: 45 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ We strongly recommend source code should be managed through Git. The benefit of
19
19
## Docker
20
20
We provide a fast and simple way of setting up a local UDOIT instance through the use of docker containers. To set up the docker containers, you must first install [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/). Then, simply run the following command from within the UDOIT directory:
21
21
22
-
docker-compose up --build
22
+
docker-compose up -d
23
23
24
24
Once the containers are up and running, you can access the php container by calling the command:
25
25
@@ -38,31 +38,46 @@ Once you have set up the containers in this way, you will still need to follow t
38
38
## Configuring your Web Server
39
39
The details of configuring a web server with PHP are out of the scope of this README. You should configure your web server to point to UDOIT's "public" folder as the web root folder. Doing this will hide the configuration and source files so that they are not web accessible. It will also clean up your URL structure so that you don't need to include the "public" folder in any of the URLs to UDOIT.
40
40
41
-
If you are setting up a local UDOIT instance through Docker, you can simplify this step and quickly setup a server by calling the following command from within the php container:
41
+
If you are setting up a local UDOIT instance through Docker, you can simplify this step and quickly setup a server by calling the following commands from within the php container:
42
42
43
+
docker exec -it udoit_php_1 /bin/bash
43
44
symfony server:ca:install
45
+
symfony serve -d
44
46
45
-
Followed by the following command:
47
+
Security Note: Do not use the commands above for production installations. Use software such as [Apache](https://httpd.apache.org) or [NGINX](https://nginx.org).
46
48
47
-
symfony serve -d
49
+
SSL Issues: It is important to note that most browsers will automatically block unsigned certificates, and the tool might fail to load with the message that the website might be down or have moved to a new location. If this happens to you after going through the rest of the instructions, you can bypass this warning by opening the specified url in a new tab, granting the browser permission to access the webpage, and then going back to where the UDOIT tool has been integrated and refreshing the page.
48
50
49
-
It is important to note that most browsers will automatically block unsigned certificates, and the tool might fail to load with the message that the website might be down or have moved to a new location. If this happens to you after going through the rest of the instructions, you can bypass this warning by opening the specified url in a new tab, granting the browser permission to access the webpage, and then going back to where the UDOIT tool has been integrated and refreshing the page.
51
+
> If you are running UDOIT in Docker, you will need do this each time you start the docker container.
50
52
51
53
## Installing Composer Dependencies
52
-
UDOIT uses Composer to install PHP dependencies. Installing Composer is out of the scope of this README, but here is some documentation on [Composer Installation](https://getcomposer.org/doc/00-intro.md#introduction).
54
+
UDOIT uses Composer to install PHP dependencies. If you are using Docker, it will already be installed inside the PHP container. To install the required PHP dependencies, enter the PHP container with:
55
+
56
+
docker exec -it udoit_php_1 /bin/bash
57
+
58
+
Then, install the dependencies:
59
+
60
+
composer install --no-dev
53
61
54
-
Assuming you have Composer installed, navigate to your UDOIT directory in the CLI and run this command:
62
+
If you're not using Docker, follow the upstream documentation on [Composer Installation](https://getcomposer.org/download/) to install `composer.phar` into the project root, then run the following:
55
63
56
64
php composer.phar install --no-dev
57
65
66
+
> Remove the `--no-dev` flag if you wish to use `APP_ENV=dev` below.
67
+
58
68
## .ENV Setup
59
69
UDOIT uses a `.env` file for storing configuration. Local configuration such as database information and URLs should be stored in a `.env.local` file that is NOT tracked in Git.
70
+
71
+
> These changes should be made outside any of the Docker containers.
72
+
60
73
1. Copy the file `.env.local.example` to `.env.local`.
61
-
2. Change `APP_ENV` to
62
-
*`dev` if you are setting up a development environment
63
-
*`prod` if you are setting up a production server
74
+
```
75
+
cp .env.local.example .env.local
76
+
```
77
+
2. Leave `APP_ENV` set to `prod`
78
+
> If you are setting up a development environment, set this to `dev` and follow the steps in [Installing Composer Dependencies](#installing-composer-dependencies) without the `--no-dev` flag to obtain all of the development packages.
64
79
3. Add your database information to this `DATABASE_URL` variable.
65
-
4. Add the `BASE_URL`, which is the full URL to reach the `public` folder of UDOIT. (i.e. https://udoit3.ciditools.com)
80
+
4. Add the `BASE_URL`, which is the full URL to reach the `public` folder of UDOIT. (i.e. https://udoit3.ciditools.com) WITHOUT the trailing slash.
66
81
5. Set `APP_LMS` to the name of your LMS.
67
82
*`canvas` if you are using the Canvas LMS.
68
83
*`d2l` if you are using the D2l Brightspace LMS.
@@ -71,6 +86,12 @@ UDOIT uses a `.env` file for storing configuration. Local configuration such as
71
86
## Database Setup
72
87
While UDOIT is configured to use MySQL or MariaDB by default, Symfony can be configured to work with other databases as well. See the Symfony documentation for details.
73
88
89
+
> If you are running UDOIT in Docker, you don't need to install PHP on your system. You can run
90
+
>
91
+
> docker exec -it udoit_php_1 /bin/bash
92
+
>
93
+
> and then run the commands below inside the Docker container.
94
+
74
95
You can create your database manually, or use `Symfony` to create the database with this command:
75
96
76
97
php bin/console doctrine:database:create
@@ -87,12 +108,20 @@ If you are operating in a production environment you will need to generate the d
87
108
88
109
php bin/console cache:warmup --env=prod
89
110
90
-
## Javascript
91
-
UDOIT uses `node` and `yarn` to compile the javascript. Instructions for installing Node and Yarn are out of the scope of this README. TO install the javascript dependencies run the command:
111
+
## JavaScript
112
+
UDOIT uses [node](https://nodejs.org) and [yarn](https://yarnpkg.com/) to compile the JavaScript. Instructions for installing Node and Yarn are out of the scope of this README.
113
+
114
+
> If you are running UDOIT in Docker, you don't need to install Node or Yarn on your system. Run
115
+
>
116
+
> docker exec -it udoit_php_1 /bin/bash
117
+
>
118
+
> and then run the following commands inside the Docker container.
119
+
120
+
To install the JavaScript dependencies run the command:
92
121
93
122
yarn install
94
123
95
-
To build the javascript files for production, run the command:
124
+
To build the JavaScript files for production, run the command:
96
125
97
126
yarn build
98
127
@@ -103,9 +132,9 @@ However, UDOIT does have one URL that is publicly available outside of the LMS.
103
132
104
133
<BASE_URL>/lti/config
105
134
106
-
For example, if you are setting this up on your local computer it may look like:
135
+
For example, if you are setting this up on your local computer via Docker, it may look like:
107
136
108
-
https://udoit.local/lti/config
137
+
https://localhost:8000/lti/config
109
138
110
139
## Configuring Your LMS
111
140
You will need to complete the steps in the [INSTALL_CANVAS.md](INSTALL_CANVAS.md) or [INSTALL_D2L.md](INSTALL_D2L.md) to configure UDOIT to work within your LMS.
0 commit comments