Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hbz/oerworldmap
OER World Map
https://github.com/hbz/oerworldmap
Last synced: 5 days ago
JSON representation
OER World Map
- Host: GitHub
- URL: https://github.com/hbz/oerworldmap
- Owner: hbz
- License: other
- Archived: true
- Created: 2014-12-18T12:23:54.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T00:52:44.000Z (over 1 year ago)
- Last Synced: 2024-08-01T12:29:41.444Z (3 months ago)
- Language: Java
- Homepage: https://oerworldmap.org/
- Size: 29.4 MB
- Stars: 30
- Watchers: 12
- Forks: 16
- Open Issues: 226
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - hbz/oerworldmap - OER World Map (others)
README
# Open Educational Resources (OER) World Map
For inital background information about this project please refer to the
[Request for Proposals](http://www.hewlett.org/sites/default/files/OER%20mapping%20RFP_Phase%202%20Final%20June%2023%202014.pdf).
## Setup project
### Get Source
$ git clone [email protected]:hbz/oerworldmap.git
### Create configuration
$ cp conf/application.example.conf conf/application.conf
### Setup Elasticsearch
#### [Download and install elasticsearch](https://www.elastic.co/downloads/elasticsearch)
$ cd third-party
$ wget https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.2.1.zip
$ unzip elasticsearch-6.2.1.zip
$ cd elasticsearch-6.2.1
$ bin/elasticsearch-plugin install analysis-icu
$ bin/elasticsearch
Check with `curl -X GET http://localhost:9200/` if all is well.
Optionally, you may want to [use the head plugin](https://www.elastic.co/blog/running-site-plugins-with-elasticsearch-5-0).
This basically comes down to
$ cd .. # back to oerworldmap/third-party or choose any directory outside this project
$ git clone git://github.com/mobz/elasticsearch-head.git
$ cd elasticsearch-head
$ npm install
$ npm run start
$ open http://localhost:9100/
#### Configure elasticsearch
If you are in an environment where your instance of elasticsearch won't be the only one on the network, you might want
to configure your cluster name to be different from the default `elasticsearch`. To do so, shut down elasticsearch and
edit `cluster.name` in `third-party/elasticsearch-2.4.1/config/elasticsearch.yml` and `es.cluster.name`
in `conf/application.conf` before restarting.
#### Create and configure oerworldmap index (as specified in `es.index.app.name` in `conf/application.conf`)
# from oerworldmap/ run
$ curl -H "Content-type: application/json" -X PUT http://localhost:9200/oerworldmap/ -d @conf/index-config.json
#### If you're caught with some kind of buggy index during development, simply delete the index and re-create:
$ curl -X DELETE http://localhost:9200/oerworldmap/
$ curl -X PUT http://localhost:9200/oerworldmap/ -d @conf/index-config.json
#### Set up Keycloak
Download Keycloak 4.8.3:
$ curl https://downloads.jboss.org/keycloak/4.8.3.Final/keycloak-4.8.3.Final.tar.gz | tar xvz
Modify `standalone/configuration/standalone.xml` file and add the `proxy-address-forwarding="true"` attribute to `` element under ``
Create the admin user:
$ bin/add-user-keycloak.sh -u admin
Start the server:
$ bin/standalone.sh -Dkeycloak.profile.feature.scripts=enabled
Next, login in to the admin UI at `http://localhost:8080/auth/` and complete the following steps:
- Create a realm called oerworldmap
- Enable "User registration", "Email as username", "Forgot password" and "Login with email" in the "Realm Settings > Login" section
- If you want to enable Email verification, configure an SMTP server in the "Realm Settings > Email" section
- Install & configure theme from https://github.com/hbz/oerworldmap-keycloak-theme:
- `cd themes && git clone [email protected]:hbz/oerworldmap-keycloak-theme.git`
- Set `oerworldmap-keycloak-theme` as "Login Theme", "Account Theme" and "Email Theme" in the "Realm Settings > Themes" section
- For ReCaptcha support, configure "Realm Settings > Security Defenses":
- `SAMEORIGIN; ALLOW-FROM https://www.google.com` as X-Frame-Options
- `frame-src 'self' https://www.google.com; frame-ancestors 'self'; object-src 'none';` as Content-Security-Policy
- Select the "account" client ID in the "Clients" section and as follows:
- Set `/*` as "Valid Redirect URIs" and set `/.login` as the Base URL in the "Settings" section
- Set up Mappers for profile_id and groups in the "Mappers" section
- Copy the client secret from the "Clients > account > Credentials" section to `conf/vhost.conf` (line 14)
- In the "Authentication > Flows" section, copy the "Registration" flow and name it "Registration with Validation and Newsletter":
- Click "Add Execution", select "Script" from the "Provider" drop down and hit save, the new script will show up at the bottom of the table
- Set it to "REQUIRED" and select "Config" from the "Actions drop down"
- Set the "Alias" to "Validate custom attributes"
- Copy the script provided in `scripts/keycloakValidateCustomAttributes.js` to "Script Source"
- Click "Add Execution", select "Script" from the "Provider" drop down and hit save, the new script will show up at the bottom of the table
- Set it to "REQUIRED" and select "Config" from the "Actions drop down"
- Set the "Alias" to "Subscribe newsletter"
- Copy the script provided in `scripts/keycloakRegisterNewsletter.js` to "Script Source"
- Finally, configure the Keykloak connection in the APIs `conf/application.conf`:
- keycloak.realm="oerworldmap"
- keycloak.username="YOUR_KEYCLOAK_ADMIN_USER"
- keycloak.password="YOUR_KEYCLOAK_ADMIN_PASSWORD"
- keycloak.client="admin-cli"
Install [mod_auth_openidc](https://github.com/zmartzone/mod_auth_openidc), if not on a supported system build from source:
```
$ git clone https://github.com/zmartzone/mod_auth_openidc.git
$ cd mod_auth_openidc
$ ./autogen.sh
$ zypper in apache2-devel
$ zypper in libcurl-devel
$ wget http://mirror.centos.org/centos/7/os/x86_64/Packages/jansson-2.10-1.el7.x86_64.rpm
$ rpm -i jansson-2.10-1.el7.x86_64.rpm
$ wget http://mirror.centos.org/centos/7/os/x86_64/Packages/jansson-devel-2.10-1.el7.x86_64.rpm
$ rpm -i jansson-devel-2.10-1.el7.x86_64.rpm
$ ln -s /lib64/libcrypto.so.1.0.0 /usr/lib64/libcrypto.so.10
$ wget https://mod-auth-openidc.org/download/cjose-0.5.1-1.el7.centos.x86_64.rpm
$ rpm -iv cjose-0.5.1-1.el7.centos.x86_64.rpm --nodeps
$ zypper in pcre-devel
$ ./configure --with-apxs2=/usr/bin/apxs2
$ make
$ make install
$ a2enmod auth_openidc
```
#### Set up Apache
$ sudo apt-get install apache2 libapache2-mod-auth-openidc
$ sudo a2enmod proxy proxy_html proxy_http rewrite auth_openidc ssl headers
$ mkdir data/auth
$ cd data/auth
$ touch htpasswd htgroups htprofiles
Edit `sudo visudo` and add permission to the user
username ALL = NOPASSWD: /usr/sbin/apache2ctl
Configure variables for `conf/vhost.conf`
Define PUBLIC_HOST oerworldmap.localhost
Define PUBLIC_PORT 80
Define PUBLIC_EMAIL [email protected]
Define AUTH_DIR /home/fo/local/src/oerworldmap/data
Define API_HOST http://localhost:9000
Define UI_HOST http://localhost:3000
Define KIBANA_HOST http://localhost:5601
Define PAGES_HOST http://localhost:4000
#Define SSL_CIPHER_SUITE
#Define SSL_CERT_FILE
#Define SSL_CERT_KEY_FILE
#Define SSL_CERT_CHAIN_FILE
Enable the site
$ sudo ln -s /home/username/oerworldmap/conf/vhost.conf /etc/apache2/sites-available/oerworldmap.conf
$ sudo a2ensite oerworldmap.conf
$ sudo apache2ctl graceful
Modify the path in `data/permissions/.system`
AuthUserFile /home/username/oerworldmap/data/auth/htpasswd
AuthGroupFile /home/username/oerworldmap/data/auth/htgroups
Set up the hostname in `/etc/hosts`
127.0.0.1 localhost oerworldmap.local
### Create database histories
$ mkdir -p data/consents/objects
$ touch data/consents/history
$ mkdir -p data/commits/objects/
$ touch data/commits/history
### Setup Play! Application
Download [sbt](http://www.scala-sbt.org/download.html) (version 0.13.11), then
$ sbt clean stage; sbt run
#### Sbt on Ubuntu
If you are running [bintray](https://www.scala-sbt.org/1.x/docs/Installing-sbt-on-Linux.html#Ubuntu+and+other+Debian-based+distributions) packages, make sure to install correct version:
```
$ sudo apt-get install sbt=0.13.11
```
### Install UI
UI Components are available at https://github.com/hbz/oerworldmap-ui
## Running services
- copy `scripts/services/services.example.conf` to `scripts/services/services.conf` and update vars
- copy `scripts/services/*.service` to `/etc/systemd/system` and update `EnvironmentFile`, `User` and `Group` in each service
- run `sudo systemctl daemon-reload`
### Work with IDEs
Using [activator](http://www.lightbend.com/community/core-tools/activator-and-sbt), integration to Eclipse and IDEA IntelliJ is provided by running `eclipse` or `idea` from within activator. To run the OER World Map JUnit tests inside IntelliJ, it is necessary to set the test's working directory to the root directory of this project (i. e. `oerworldmap`):
Run | Edit configurations... | JUnit | | Configuration | Working directory:
## Troubleshooting
> [ERROR] Failed to construct terminal; falling back to unsupported
> java.lang.NumberFormatException: For input string: "0x100"
Workaround for this is to export correct xterm (put it in your `.bashrc` or similar):
```
export TERM=xterm-color
```
> ```
> [info] Loading project definition from /home/vagrant/oerworldmap/project
> java.lang.NullPointerException
> ```
Make sure your sbt is correct version (0.13.11).
> ```
> org.elasticsearch.ElasticsearchException: Unable to find a field mapper for field [link_count]. No 'missing' value defined.
> at org.elasticsearch.index.query.functionscore.FieldValueFactorFunctionBuilder.doToFunction(FieldValueFactorFunctionBuilder.java:151) ~[elasticsearch-6.2.1.jar:6.2.1]
> ```
Make sure that when you create and configure oerworldmap index, you do it from `oerworldmap/` folder.
## Loading data
```
# Reset elasticsearch index
curl -X DELETE http://localhost:9200/oerworldmap/
curl -H "Content-type: application/json" -X PUT http://localhost:9200/oerworldmap/ -d @conf/index-config.json
# Delete triple store
rm data/tdb/*
# Delete history
rm -r data/commits/
# Extract history from archive
tar -xzf commits.tar.gz -C data/
```
Afterwards, restart `sbt` and wait until it fully rebuilds triplestore and Elastic Search index. Once it's done, you can check if it's working correctly by running:
```
curl localhost:9000/resource.json
```
## Updating vocabulary
When updating vocabulary definitions, you need to update triple store by running:
(example for publications.json)
curl -H "Content-type: application/json" http://localhost:9000/import/ -d @src/json/publications.json
## Contribute
### Coding conventions
Indent blocks by *two spaces* and wrap lines at *100 characters*. For more
details, refer to the [Google Java Style
Guide](https://google-styleguide.googlecode.com/svn/trunk/javaguide.html).
### Bug reports
Please file bugs as an issue labeled "Bug" [here](https://github.com/hbz/oerworldmap/issues/new). Include browser information and screenshot(s) when applicable.
## Attributions
This product includes GeoLite2 data created by MaxMind, available from
http://www.maxmind.com.