Skip to content

Commit 071fb61

Browse files
authored
Update README with contribution and license details.
1 parent ae8b2bb commit 071fb61

File tree

1 file changed

+34
-10
lines changed

1 file changed

+34
-10
lines changed

README.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,42 +5,59 @@ This project is a standalone Solid Server.
55
It reuses the PHP libraries from PDS Interop as the basis for the Solid server.
66
For the user management, no framework is used to keep the codebase lean.
77

8-
# Project maturity
9-
10-
This project is currently EXPERIMENTAL and should not be used in production yet.
11-
12-
# Installation
8+
## Installation
139

1410
Start the docker containers:
15-
```
11+
12+
```sh
1613
docker-compose up
1714
```
15+
1816
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.
1917
The persisted data will be stored in the data/ directory. This contains the keys, pods, db and mailpit data.
2018

2119
Run the following commands to set up the container (replace 'solid' below with the name of your container):
2220
Note: Update the values in the config.php file where needed befure running the init script.
2321

24-
```
22+
```sh
2523
docker exec -w /opt/solid/ solid cp config.php.example config.php
2624
docker exec -u www-data -i -w /opt/solid/ solid php init.php
2725
docker exec -w /opt/solid/ solid chown -R www-data:www-data keys pods db
2826
```
2927

30-
## DNS gotcha and snake oil certificate
28+
### DNS gotcha and snake oil certificate
3129

3230
The webIds are created as id-xxxxx.{baseHost}, so in our example, that would be id-xxxx.solid.local.
3331
Storage pods are created as storage-xxxxx.{baseHost}, so that would become storage-xxxx.solid.local.
3432
The snake oil certificate is only for localhost, so accessing this will generate a warning for an invalid certificate;
3533

3634
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.
3735

38-
# This solid server was built op on these releases:
36+
### This solid server was built op on these releases:
3937
- pdsinterop/flysystem-rdf (v0.6.0)
4038
- pdsinterop/php-solid-crud (v0.8.1)
4139
- pdsinterop/php-solid-auth (v0.13.0)
4240

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
4461

4562
<p>
4663
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.
@@ -51,3 +68,10 @@ You may also need to add these hosts to /etc/hosts to make them available for th
5168
<a href="https://nlnet.nl/core"><img height="64" alt="NGI0 Core logo" src="https://nlnet.nl/image/logos/NGI0Core_tag.svg"></a>
5269
<a href="https://ec.europa.eu/"><img height="64" alt="European Commision logo" src="https://nlnet.nl/image/logos/EC.svg"></a>
5370
</p>
71+
72+
[code-of-conduct]: https://pdsinterop.org/code-of-conduct/
73+
[contributing-link]: https://pdsinterop.org/contributing/
74+
[contributors-page]: https://github.com/pdsinterop/multiuser-php-solid-server/contributors
75+
[issues-link]: https://github.com/pdsinterop/multiuser-php-solid-server//issues
76+
[license-link]: https://pdsinterop.org/license/
77+
[releases-page]: https://github.com/pdsinterop/multiuser-php-solid-server/releases

0 commit comments

Comments
 (0)