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-10Lines changed: 34 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,42 +5,59 @@ This project is a standalone Solid Server.
5
5
It reuses the PHP libraries from PDS Interop as the basis for the Solid server.
6
6
For the user management, no framework is used to keep the codebase lean.
7
7
8
-
# Project maturity
9
-
10
-
This project is currently EXPERIMENTAL and should not be used in production yet.
11
-
12
-
# Installation
8
+
## Installation
13
9
14
10
Start the docker containers:
15
-
```
11
+
12
+
```sh
16
13
docker-compose up
17
14
```
15
+
18
16
This will start up three containers: the solid server, pubsub server and a mailpit server. If you have an actual SMTP server running, feel free to remove the mailpit container.
19
17
The persisted data will be stored in the data/ directory. This contains the keys, pods, db and mailpit data.
20
18
21
19
Run the following commands to set up the container (replace 'solid' below with the name of your container):
22
20
Note: Update the values in the config.php file where needed befure running the init script.
The webIds are created as id-xxxxx.{baseHost}, so in our example, that would be id-xxxx.solid.local.
33
31
Storage pods are created as storage-xxxxx.{baseHost}, so that would become storage-xxxx.solid.local.
34
32
The snake oil certificate is only for localhost, so accessing this will generate a warning for an invalid certificate;
35
33
36
34
You may also need to add these hosts to /etc/hosts to make them available for the browser by pointing them to 127.0.0.1.
37
35
38
-
# This solid server was built op on these releases:
36
+
###This solid server was built op on these releases:
39
37
- pdsinterop/flysystem-rdf (v0.6.0)
40
38
- pdsinterop/php-solid-crud (v0.8.1)
41
39
- pdsinterop/php-solid-auth (v0.13.0)
42
40
43
-
# Funding
41
+
## Contributing
42
+
43
+
Questions or feedback can be given by [opening an issue on GitHub][issues-link].
44
+
45
+
All PDS Interop projects are open source and community-friendly.
46
+
Any contribution is welcome!
47
+
For more details read the [contribution guidelines][contributing-link].
48
+
49
+
All PDS Interop projects adhere to [the Code Manifesto](http://codemanifesto.com)
50
+
as its [code-of-conduct][code-of-conduct]. Contributors are expected to abide by its terms.
51
+
52
+
There is [a list of all contributors on GitHub][contributors-page].
53
+
54
+
For a list of changes see the [the GitHub releases page][releases-page].
55
+
56
+
## License
57
+
58
+
All code created by PDS Interop is licensed under the [MIT License][license-link].
59
+
60
+
## Funding
44
61
45
62
<p>
46
63
This project was funded through the <ahref="https://nlnet.nl/core">NGI0 Core</a> Fund, established by <ahref="https://nlnet.nl">NLnet</a> with financial support from the European Commission's <ahref="https://ngi.eu">Next Generation Internet</a> programme.
@@ -51,3 +68,10 @@ You may also need to add these hosts to /etc/hosts to make them available for th
0 commit comments