Skip to content

Commit ff5d8b4

Browse files
authored
README updates (#216)
* SNAPSHOT bump * Update README.md Updated YouTube link * Update README.md Removed old app examples * Updated README
1 parent f62e910 commit ff5d8b4

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44

55
![LinkedDataHub screenshots](https://github.com/AtomGraph/LinkedDataHub/raw/master/screenshots.png)
66

7-
What's new in LinkedDataHub v3? Watch this video for a feature overview:
8-
[![What's new in LinkedDataHub v3? Feature overview](https://img.youtube.com/vi/phRL6QtVTG0/0.jpg)](https://www.youtube.com/watch?v=phRL6QtVTG0)
7+
What's new in LinkedDataHub v5? Watch this video for a feature overview:
8+
[![What's new in LinkedDataHub v3? Feature overview](https://img.youtube.com/vi/LaOouEYhp_c/0.jpg)](https://www.youtube.com/watch?v=LaOouEYhp_c)
99

1010
We started the project with the intention to use it for Linked Data publishing, but gradually realized that we've built a multi-purpose data-driven platform.
1111

@@ -59,10 +59,14 @@ It takes a few clicks and filling out a form to install the product into your ow
5959
```
6060
3. Setup server's SSL certificates by running this from command line:
6161
```shell
62-
./scripts/server-cert-gen.sh .env nginx ssl
62+
./bin/server-cert-gen.sh .env nginx ssl
6363
```
6464
The script will create an `ssl` sub-folder where the SSL certificates and/or public keys will be placed.
65-
4. Launch the application services by running this from command line:
65+
4. Create the following secrets with certificate passwords:
66+
- `secrets/client_truststore_password.txt`
67+
- `secrets/owner_cert_password.txt`
68+
- `secrets/secretary_cert_password.txt`
69+
5. Launch the application services by running this from command line:
6670
```shell
6771
docker-compose up --build
6872
```
@@ -72,22 +76,23 @@ It takes a few clicks and filling out a form to install the product into your ow
7276
* `secretary` stores root application's WebID certificate, keystore, and public key
7377
* `server` stores the server's certificate (also used by nginx)
7478
- `data` where the triplestore(s) will persist RDF data
79+
- `datasets` where LDH persists agent metadata files
7580
- `uploads` where LDH stores content-hashed file uploads
7681
It should take up to half a minute as datasets are being loaded into triplestores. After a successful startup, the last line of the Docker log should read something like:
7782
```
7883
linkeddatahub_1 | 09-Feb-2021 14:18:10.536 INFO [main] org.apache.catalina.startup.Catalina.start Server startup in [32609] milliseconds
7984
```
80-
5. Install `ssl/owner/keystore.p12` into a web browser of your choice (password is the `$owner_cert_pwd` value supplied to `setup.sh`)
85+
6. Install `ssl/owner/keystore.p12` into a web browser of your choice (password is the `owner_cert_password` secret value)
8186
- Google Chrome: `Settings > Advanced > Manage Certificates > Import...`
8287
- Mozilla Firefox: `Options > Privacy > Security > View Certificates... > Import...`
8388
- Apple Safari: The file is installed directly into the operating system. Open the file and import it using the [Keychain Access](https://support.apple.com/guide/keychain-access/what-is-keychain-access-kyca1083/mac) tool (drag it to the `local` section).
8489
- Microsoft Edge: Does not support certificate management, you need to install the file into Windows. [Read more here](https://social.technet.microsoft.com/Forums/en-US/18301fff-0467-4e41-8dee-4e44823ed5bf/microsoft-edge-browser-and-ssl-certificates?forum=win10itprogeneral).
85-
6. For authenticated API access use the `ssl/owner/cert.pem` HTTPS client certificate.
90+
7. For authenticated API access use the `ssl/owner/cert.pem` HTTPS client certificate.
8691
If you are running Linux with user other than `root`, you might need to fix the certificate permissions because Docker bind mounts are owned by `root` by default. For example:
8792
```shell
8893
sudo setfacl -m u:$(whoami):r ./ssl/owner/*
8994
```
90-
7. Open **https://localhost:4443/** in the web browser or use `curl` for API access, for example:
95+
8. Open **https://localhost:4443/** in the web browser or use `curl` for API access, for example:
9196
```shell
9297
curl -k -E ./ssl/owner/cert.pem:<your cert password> -H "Accept: text/turtle" 'https://localhost:4443/'
9398
```
@@ -198,11 +203,6 @@ The environment variable `JENA_HOME` is used by all the command line tools to co
198203

199204
## Sample applications
200205

201-
### Third party
202-
203-
* [KGDN](https://kgdev.net) - an open-source, collaborative project documenting RDF Knowledge Graph technologies, including RDF, SPARQL, OWL, and SHACL
204-
* [LDH Uploader](https://github.com/tmciver/ldh-uploader) - a collection of shell scripts used to upload files or directory of files to a LinkedDataHub instance by [@tmciver](https://github.com/tmciver)
205-
206206
### [Demo apps](https://github.com/AtomGraph/LinkedDataHub-Apps)
207207

208208
These demo applications can be installed into a LinkedDataHub instance using `make install`. You will need to provide the path to your WebID certificate as well as its password.

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
<groupId>com.atomgraph</groupId>
55
<artifactId>linkeddatahub</artifactId>
6-
<version>5.0.14-SNAPSHOT</version>
6+
<version>5.0.15-SNAPSHOT</version>
77
<packaging>${packaging.type}</packaging>
88

99
<name>AtomGraph LinkedDataHub</name>

0 commit comments

Comments
 (0)