Skip to content

Commit adeeae0

Browse files
committed
add LICENSE and README.md - installation instructions are moved to the README
1 parent 03cbfbe commit adeeae0

2 files changed

Lines changed: 83 additions & 0 deletions

File tree

LICENSE

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright (c) 2025 PDS Interop
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy
4+
of this software and associated documentation files (the "Software"), to deal
5+
in the Software without restriction, including without limitation the rights
6+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7+
copies of the Software, and to permit persons to whom the Software is furnished
8+
to do so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
19+
THE SOFTWARE.

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Standalone PHP Solid Server
2+
3+
This project is a standalone Solid Server.
4+
5+
It reuses the PHP libraries from PDS Interop as the basis for the Solid server.
6+
For the user management, no framework is used to keep the codebase lean.
7+
8+
# Project maturity
9+
10+
This project is currently EXPERIMENTAL and should not be used in production yet.
11+
12+
# Installation
13+
14+
Start the docker containers:
15+
```
16+
docker-compose up
17+
```
18+
This will start up two containers: the solid server and a mailpit server. If you have an actual SMTP server running, feel free to remove the mailpit container.
19+
20+
Log into the container (replace 'solid' below with the name of your container).
21+
```
22+
docker exec -it solid bash
23+
```
24+
25+
Run composer install:
26+
```
27+
cd /opt/solid/
28+
composer install
29+
```
30+
31+
Copy config.php.example to config.php and update the values.
32+
```
33+
cp config.php.example config.php
34+
```
35+
36+
Run init.php to generate the keyset and create the database tables.
37+
```
38+
sudo -u www-data php init.php
39+
```
40+
41+
## DNS gotcha and snake oil certificate
42+
43+
The webIds are created as id-xxxxx.{baseHost}, so in our example, that would be id-xxxx.solid.local.
44+
Storage pods are created as storage-xxxxx.{baseHost}, so that would become storage-xxxx.solid.local.
45+
The snake oil certificate is only for localhost, so accessing this will generate a warning for an invalid certificate;
46+
47+
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.
48+
49+
# This solid server was built op on these releases:
50+
- pdsinterop/flysystem-rdf (v0.6.0)
51+
- pdsinterop/php-solid-crud (v0.8.0)
52+
- pdsinterop/php-solid-auth (v0.13.0)
53+
54+
# Funding
55+
56+
<p>
57+
This project was funded through the <a href="https://nlnet.nl/core">NGI0 Core</a> Fund, established by <a href="https://nlnet.nl">NLnet</a> with financial support from the European Commission's <a href="https://ngi.eu">Next Generation Internet</a> programme.
58+
Learn more at the <a href="https://nlnet.nl/project/Solid-NC/">NLnet project page</a>
59+
</p>
60+
<p>
61+
<a href="https://nlnet.nl"><img height="64" alt="NLNet logo" src="https://nlnet.nl/logo/banner.svg"></a>
62+
<a href="https://nlnet.nl/core"><img height="64" alt="NGI0 Core logo" src="https://nlnet.nl/image/logos/NGI0Core_tag.svg"></a>
63+
<a href="https://ec.europa.eu/"><img height="64" alt="European Commision logo" src="https://nlnet.nl/image/logos/EC.svg"></a>
64+
</p>

0 commit comments

Comments
 (0)