https://github.com/pdsinterop/php-solid-pubsub-server
Standalone PHP Solid PubSub server
https://github.com/pdsinterop/php-solid-pubsub-server
Last synced: about 2 months ago
JSON representation
Standalone PHP Solid PubSub server
- Host: GitHub
- URL: https://github.com/pdsinterop/php-solid-pubsub-server
- Owner: pdsinterop
- License: mit
- Created: 2020-11-04T14:49:19.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-06-06T13:27:38.000Z (9 months ago)
- Last Synced: 2025-06-06T13:35:01.872Z (9 months ago)
- Language: PHP
- Homepage: https://pdsinterop.org/php-solid-pubsub-server/
- Size: 63.5 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Standalone PHP Solid PubSub Server
[![PDS Interop][pdsinterop-shield]][pdsinterop-site]
[![Project stage: Development][project-stage-badge: Development]][project-stage-page]
[![License][license-shield]][license-link]
[![Latest Version][version-shield]][version-link]
[![standard-readme compliant][standard-readme-shield]][standard-readme-link]
![Maintained][maintained-shield]
_Standalone Solid PubSub Server written in PHP by PDS Interop_
## Table of Contents
## Background
The Solid specifications defines what makes a "Solid Server". Parts of
those specifications are still likely to change, but at the time of this writing,
they define:
- Authentication
- Authorization (and access control)
- Content representation
- Identity
- Profiles
- Resource (reading and writing) API
- Social Web App Protocols (Notifications, Friends Lists, Followers and Following)
### Installation
To install the project, clone it from GitHub and install the PHP dependencies
using Composer:
```sh
git clone git://github.com/pdsinterop/php-solid-pubsub-server.git \
&& cd php-solid-pubsub-server \
&& composer install --no-dev --prefer-dist
```
At this point, the application is ready to run.
## Usage
The PHP Solid PubSub server can be run in several different ways.
### Docker images
When running with your own Docker image, make sure to mount the project folder
to wherever the image expects it to be, e.g. `/app` or `/var/www`.
For instance:
```
export PORT=8080 && \
docker run \
--env "PORT=${PORT}" \
--expose "${PORT}" \
--network host \
--rm \
--volume "$PWD:/app" \
-it \
php:8.3 \
php --docroot /app/web/ --server "localhost:${PORT}" /app/web/index.php
```
Or on Mac:
```
export PORT=8080 && \
docker run \
--env "PORT=${PORT}" \
--expose "${PORT}" \
-p "${PORT}:${PORT}" \
--rm \
--volume "$PWD:/app" \
-it \
php:8.3 \
php --docroot /app/web/ --server "localhost:${PORT}" /app/web/index.php
```
## Security
If you discover any security related issues, please email instead of using the issue tracker.
## Development
### Project structure
This project is structured as follows:
```
.
├── src <- Source code
├── vendor <- Third-party and vendor code
├── web <- Web content
├── composer.json <- PHP package and dependency configuration
└── README.md <- You are now here
```
## Contributing
Questions or feedback can be given by [opening an issue on GitHub](https://github.com/pdsinterop/php-solid-pubsub-server/issues).
All PDS Interop projects are open source and community-friendly.
Any contribution is welcome!
For more details read the [contribution guidelines](contributing.md).
All PDS Interop projects adhere to [the Code Manifesto](http://codemanifesto.com)
as its [code-of-conduct](CODE_OF_CONDUCT.md). Contributors are expected to abide by its terms.
There is [a list of all contributors on GitHub][contributors-page].
For a list of changes see the [CHANGELOG](CHANGELOG.md) or the GitHub releases page.
## License
All code created by PDS Interop is licensed under the [MIT License][license-link].
[contributors-page]: https://github.com/pdsinterop/php-solid-pubsub-server/contributors
[license-link]: ./LICENSE
[license-shield]: https://img.shields.io/github/license/pdsinterop/php-solid-pubsub-server.svg
[maintained-shield]: https://img.shields.io/maintenance/yes/2025
[pdsinterop-shield]: https://img.shields.io/badge/-PDS%20Interop-gray.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii01IC01IDExMCAxMTAiIGZpbGw9IiNGRkYiIHN0cm9rZS13aWR0aD0iMCI+CiAgICA8cGF0aCBkPSJNLTEgNTJoMTdhMzcuNSAzNC41IDAgMDAyNS41IDMxLjE1di0xMy43NWEyMC43NSAyMSAwIDAxOC41LTQwLjI1IDIwLjc1IDIxIDAgMDE4LjUgNDAuMjV2MTMuNzVhMzcgMzQuNSAwIDAwMjUuNS0zMS4xNWgxN2EyMiAyMS4xNSAwIDAxLTEwMiAweiIvPgogICAgPHBhdGggZD0iTSAxMDEgNDhhMi43NyAyLjY3IDAgMDAtMTAyIDBoIDE3YTIuOTcgMi44IDAgMDE2OCAweiIvPgo8L3N2Zz4K
[pdsinterop-site]: https://pdsinterop.org/
[project-stage-badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
[standard-readme-link]: https://github.com/RichardLitt/standard-readme
[standard-readme-shield]: https://img.shields.io/badge/readme%20style-standard-brightgreen.svg
[version-link]: https://packagist.org/packages/pdsinterop/php-solid-pubsub-server
[version-shield]: https://img.shields.io/github/v/release/pdsinterop/php-solid-pubsub-server?sort=semver