From 89ba76fe250d2e7496b3f1c530ccdd74efa44432 Mon Sep 17 00:00:00 2001 From: Michiel de Jong Date: Tue, 19 Apr 2022 10:55:05 +0200 Subject: [PATCH 1/3] Split out CSS-specific instructions from self-hosting overview --- .../pod-server/2019-01-01-00_overview.md | 102 +---------------- .../pod-server/2022-04-19-00_css.md | 106 ++++++++++++++++++ 2 files changed, 108 insertions(+), 100 deletions(-) create mode 100644 _posts/developers/pod-server/2022-04-19-00_css.md diff --git a/_posts/developers/pod-server/2019-01-01-00_overview.md b/_posts/developers/pod-server/2019-01-01-00_overview.md index 5817ab13..677f8f3a 100644 --- a/_posts/developers/pod-server/2019-01-01-00_overview.md +++ b/_posts/developers/pod-server/2019-01-01-00_overview.md @@ -1,7 +1,7 @@ --- layout: for-developers title: "Setting up your own Solid server" -permalink: self-hosting/css +permalink: self-hosting/overview tags: [pod-server] categories: [Running Community Solid Server] exclude: true @@ -22,104 +22,6 @@ The following **open-source servers** are available: * [solid-nextcloud](https://github.com/pdsinterop/solid-nextcloud) as a plugin for Nextcloud * [PHP Solid Server](https://github.com/pdsinterop/php-solid-server) for PHP -We walk you through the installation of the Community Solid Server below. +We walk you through the [installation of the Community Solid Server](/self-hosting/css).
We also provide [Instructions for Node Solid Server](/self-hosting/nss). - -# Running the Community Solid Server {#running-css} -To run the Community Solid Server, -you can choose between: - -- [Node.js](#nodejs) -- [Docker](#docker) - -## Via Node.js and npm {#nodejs} -Ensure you have [installed Node.js](https://nodejs.org/en/download/). -We support versions 12.7 and up, -but recommend 14 or 16. -
-To **install the server**, open a command prompt and type: - -```shell -npm install -g @solid/community-server -``` - -To **run the server** with in-memory storage, type: -```shell -community-solid-server -``` - -To run the server with **file-based storage**, type: -```shell -community-solid-server -c @css:config/file.json -``` - -You can now [access your server](#access) locally. - -## Via Docker {#docker} -[Docker](https://docs.docker.com/get-docker/) allows you to run the server -without having Node.js installed: -```shell -# Clone the repo to get access to the configs -git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git -cd CommunitySolidServer -# Run the image, serving your `~/Solid` directory on `http://localhost:3000` -docker run --rm -v ~/Solid:/data -p 3000:3000 -it solidproject/community-server:latest -# Or use one of the built-in configurations -docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json -# Or use your own configuration mapped to the right directory -docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json -``` - -## Accessing your server {#access} -Open your browser and visit [http://localhost:3000/](http://localhost:3000/). -You will be greeted by a welcome page. - -This welcome page is hosted on a _root Pod_, -to which **you and your apps can read and write**. - -![Community Solid Server welcome page](/assets/img/screenshots/css-welcome-page.png) - -## Creating your own account {#account} -To create your own account, -visit [http://localhost:3000/idp/register/](http://localhost:3000/idp/register/). -
-The server can then **host your Pod and WebID**. - -![Community Solid Server registration page](/assets/img/screenshots/css-register-page.png) - -## Extending your server -The Community Solid Server is highly modular -and supports many different configurations and plugins. - -The [Recipes](https://github.com/CommunitySolidServer/Recipes) -contain a couple of examples to get started. - -These are some plugins you can add to your server: -- [Dgraph backend](https://github.com/comake/solid-dgraph) -- [Redis backend](https://github.com/comake/solid-redis) -- [Philips Hue backend](https://github.com/RubenVerborgh/solid-hue) - -## Exposing your server publicly {#public} - -The Solid server will run as a local Web server. -You can expose the server directly -either by running it on a public port -or by placing it behind a _reverse proxy_. - -When going public, -be sure to tell the server its base URL via the `-b` flag: - -```shell -community-solid-server -b https://server.example/ -``` - -Here are instructions to set up common proxy servers: - -- [NGINX](/for-developers/pod-server/nginx) -- [Apache](/for-developers/pod-server/apache) - -## Feedback and questions {#feedback} -If you have feedback or questions about the server, -don't hesitate to [start a discussion](https://github.com/CommunitySolidServer/CommunitySolidServer/discussions) -or [report a bug](https://github.com/CommunitySolidServer/CommunitySolidServer/issues). diff --git a/_posts/developers/pod-server/2022-04-19-00_css.md b/_posts/developers/pod-server/2022-04-19-00_css.md new file mode 100644 index 00000000..668ade7c --- /dev/null +++ b/_posts/developers/pod-server/2022-04-19-00_css.md @@ -0,0 +1,106 @@ +--- +layout: for-developers +title: "Setting up Community Solid server" +permalink: self-hosting/css +tags: [pod-server] +categories: [Running Community Solid Server] +exclude: true +--- + +# Running the Community Solid Server {#running-css} +To run the Community Solid Server, +you can choose between: + +- [Node.js](#nodejs) +- [Docker](#docker) + +## Via Node.js and npm {#nodejs} +Ensure you have [installed Node.js](https://nodejs.org/en/download/). +We support versions 12.7 and up, +but recommend 14 or 16. +
+To **install the server**, open a command prompt and type: + +```shell +npm install -g @solid/community-server +``` + +To **run the server** with in-memory storage, type: +```shell +community-solid-server +``` + +To run the server with **file-based storage**, type: +```shell +community-solid-server -c @css:config/file.json +``` + +You can now [access your server](#access) locally. + +## Via Docker {#docker} +[Docker](https://docs.docker.com/get-docker/) allows you to run the server +without having Node.js installed: +```shell +# Clone the repo to get access to the configs +git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git +cd CommunitySolidServer +# Run the image, serving your `~/Solid` directory on `http://localhost:3000` +docker run --rm -v ~/Solid:/data -p 3000:3000 -it solidproject/community-server:latest +# Or use one of the built-in configurations +docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json +# Or use your own configuration mapped to the right directory +docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json +``` + +## Accessing your server {#access} +Open your browser and visit [http://localhost:3000/](http://localhost:3000/). +You will be greeted by a welcome page. + +This welcome page is hosted on a _root Pod_, +to which **you and your apps can read and write**. + +![Community Solid Server welcome page](/assets/img/screenshots/css-welcome-page.png) + +## Creating your own account {#account} +To create your own account, +visit [http://localhost:3000/idp/register/](http://localhost:3000/idp/register/). +
+The server can then **host your Pod and WebID**. + +![Community Solid Server registration page](/assets/img/screenshots/css-register-page.png) + +## Extending your server +The Community Solid Server is highly modular +and supports many different configurations and plugins. + +The [Recipes](https://github.com/CommunitySolidServer/Recipes) +contain a couple of examples to get started. + +These are some plugins you can add to your server: +- [Dgraph backend](https://github.com/comake/solid-dgraph) +- [Redis backend](https://github.com/comake/solid-redis) +- [Philips Hue backend](https://github.com/RubenVerborgh/solid-hue) + +## Exposing your server publicly {#public} + +The Solid server will run as a local Web server. +You can expose the server directly +either by running it on a public port +or by placing it behind a _reverse proxy_. + +When going public, +be sure to tell the server its base URL via the `-b` flag: + +```shell +community-solid-server -b https://server.example/ +``` + +Here are instructions to set up common proxy servers: + +- [NGINX](/for-developers/pod-server/nginx) +- [Apache](/for-developers/pod-server/apache) + +## Feedback and questions {#feedback} +If you have feedback or questions about the server, +don't hesitate to [start a discussion](https://github.com/CommunitySolidServer/CommunitySolidServer/discussions) +or [report a bug](https://github.com/CommunitySolidServer/CommunitySolidServer/issues). From 2b28f36d8bc06f53ca5f4b940bd527eebea3761e Mon Sep 17 00:00:00 2001 From: Michiel de Jong Date: Fri, 22 Apr 2022 09:29:05 +0200 Subject: [PATCH 2/3] Add link to features matrix in current location Note that https://github.com/solid/test-suite will soon move to https://github.com/solid-test-suite , see https://gitter.im/solid/test-suite?at=625d37869bd1c71ecaf877a5 but we can update this link after it does. --- _posts/developers/pod-server/2019-01-01-00_overview.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_posts/developers/pod-server/2019-01-01-00_overview.md b/_posts/developers/pod-server/2019-01-01-00_overview.md index 677f8f3a..fb63c6ab 100644 --- a/_posts/developers/pod-server/2019-01-01-00_overview.md +++ b/_posts/developers/pod-server/2019-01-01-00_overview.md @@ -22,6 +22,8 @@ The following **open-source servers** are available: * [solid-nextcloud](https://github.com/pdsinterop/solid-nextcloud) as a plugin for Nextcloud * [PHP Solid Server](https://github.com/pdsinterop/php-solid-server) for PHP +See [the features matrix](https://github.com/solid/test-suite#table) to find out which server implementation supports which required and/or optional parts of the Solid spec. + We walk you through the [installation of the Community Solid Server](/self-hosting/css).
We also provide [Instructions for Node Solid Server](/self-hosting/nss). From ff3db83427c8928802c839e3b8f2b54fbb4c565a Mon Sep 17 00:00:00 2001 From: Michiel de Jong Date: Tue, 10 May 2022 09:35:46 +0200 Subject: [PATCH 3/3] Update _posts/developers/pod-server/2019-01-01-00_overview.md Co-authored-by: Sarven Capadisli --- _posts/developers/pod-server/2019-01-01-00_overview.md | 1 - 1 file changed, 1 deletion(-) diff --git a/_posts/developers/pod-server/2019-01-01-00_overview.md b/_posts/developers/pod-server/2019-01-01-00_overview.md index fb63c6ab..ba205533 100644 --- a/_posts/developers/pod-server/2019-01-01-00_overview.md +++ b/_posts/developers/pod-server/2019-01-01-00_overview.md @@ -22,7 +22,6 @@ The following **open-source servers** are available: * [solid-nextcloud](https://github.com/pdsinterop/solid-nextcloud) as a plugin for Nextcloud * [PHP Solid Server](https://github.com/pdsinterop/php-solid-server) for PHP -See [the features matrix](https://github.com/solid/test-suite#table) to find out which server implementation supports which required and/or optional parts of the Solid spec. We walk you through the [installation of the Community Solid Server](/self-hosting/css).