Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/7.x/docs/index.html

67 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Community Solid Server - v7.1.2</title><meta name="description" content="Documentation for Community Solid Server"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Community Solid Server - v7.1.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Community Solid Server - v7.1.2</h2></div><div class="tsd-panel tsd-typography"><a id="md:community-solid-server" class="tsd-anchor"></a><h1 class="tsd-anchor-link">Community Solid Server<a href="#md:community-solid-server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h1><p><img src="https://raw.githubusercontent.com/CommunitySolidServer/CommunitySolidServer/main/templates/images/solid.svg"
alt="[Solid logo]" height="150" align="right"/></p>
<p><a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/LICENSE.md"><img src="https://img.shields.io/npm/l/@solid/community-server" alt="MIT license"></a>
<a href="https://www.npmjs.com/package/@solid/community-server"><img src="https://img.shields.io/npm/v/@solid/community-server" alt="npm version"></a>
<a href="https://www.npmjs.com/package/@solid/community-server"><img src="https://img.shields.io/node/v/@solid/community-server" alt="Node.js version"></a>
<a href="https://github.com/CommunitySolidServer/CommunitySolidServer/actions"><img src="https://github.com/CommunitySolidServer/CommunitySolidServer/workflows/CI/badge.svg" alt="Build Status"></a>
<a href="https://coveralls.io/github/CommunitySolidServer/CommunitySolidServer"><img src="https://coveralls.io/repos/github/CommunitySolidServer/CommunitySolidServer/badge.svg" alt="Coverage Status"></a>
<a href="https://zenodo.org/badge/latestdoi/265197208"><img src="https://zenodo.org/badge/265197208.svg" alt="DOI"></a>
<a href="https://github.com/CommunitySolidServer/CommunitySolidServer/discussions"><img src="https://img.shields.io/github/discussions/CommunitySolidServer/CommunitySolidServer" alt="GitHub discussions"></a>
<a href="https://gitter.im/CommunitySolidServer/community"><img src="https://badges.gitter.im/CommunitySolidServer/community.svg" alt="Chat on Gitter"></a></p>
<p><strong>The Community Solid Server is open software
that provides you with a <a href="https://solidproject.org/">Solid</a> Pod and identity.
This Pod acts as your own personal storage space
so you can share data with people and Solid applications.</strong></p>
<p>As an open and modular implementation of the
<a href="https://solidproject.org/TR/">Solid specifications</a>,
the Community Solid Server is a great companion:</p>
<ul>
<li>
<p>🧑🏽 <strong>for people</strong> who want to try out having their own Pod</p>
</li>
<li>
<p>👨🏿‍💻 <strong>for developers</strong> who want to quickly create and test Solid apps</p>
</li>
<li>
<p>👩🏻‍🔬 <strong>for researchers</strong> who want to design new features for Solid</p>
</li>
</ul>
<p>And, of course, for many others who like to experience Solid.</p>
<a id="md:⚡-running-the-community-solid-server" class="tsd-anchor"></a><h2 class="tsd-anchor-link">⚡ Running the Community Solid Server<a href="#md:⚡-running-the-community-solid-server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Make sure you have <a href="https://nodejs.org/en/">Node.js</a> 18.0 or higher.
If this is your first time using Node.js,
you can find instructions on how to do this <a href="https://nodejs.org/en/download/package-manager">here</a>.</p>
<pre><code class="shell"><span class="hl-0">npx</span><span class="hl-1"> </span><span class="hl-2">@solid/community-server</span>
</code><button type="button">Copy</button></pre>
<p>Now visit your brand new server at <a href="http://localhost:3000/">http://localhost:3000/</a>!</p>
<p>To persist your pod's contents between restarts, use:</p>
<pre><code class="shell"><span class="hl-0">npx</span><span class="hl-1"> </span><span class="hl-2">@solid/community-server</span><span class="hl-1"> </span><span class="hl-3">-c</span><span class="hl-1"> </span><span class="hl-2">@css:config/file.json</span><span class="hl-1"> </span><span class="hl-3">-f</span><span class="hl-1"> </span><span class="hl-2">data/</span>
</code><button type="button">Copy</button></pre>
<p>In case you prefer to use Docker instead,
you can find instructions for this and other methods in the
<a href="https://communitysolidserver.github.io/CommunitySolidServer/latest/usage/starting-server/">documentation</a>.</p>
<a id="md:🔧-configure-your-server" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🔧 Configure your server<a href="#md:🔧-configure-your-server" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Substantial changes to server behavior can be achieved via JSON configuration files.
The Community Solid Server uses <a href="https://componentsjs.readthedocs.io/en/latest/">Components.js</a>
to specify how modules and components need to be wired together at runtime.</p>
<p>Recipes for configuring the server can be found at <a href="https://github.com/CommunitySolidServer/recipes">CommunitySolidServer/recipes</a>.</p>
<p>Examples and guidance on custom configurations
are available in the <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/tree/main/config"><code>config</code> folder</a>,
and the <a href="https://github.com/CommunitySolidServer/tutorials/blob/main/custom-configurations.md">configurations tutorial</a>.
There is also a <a href="https://communitysolidserver.github.io/configuration-generator/">configuration generator</a>.</p>
<a id="md:👩🏽💻-developing-server-code" class="tsd-anchor"></a><h2 class="tsd-anchor-link">👩🏽‍💻 Developing server code<a href="#md:👩🏽💻-developing-server-code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The server allows writing and plugging in custom modules
without altering its base source code.</p>
<p>The <a href="https://communitysolidserver.github.io/CommunitySolidServer/5.x/docs">📗 API documentation</a> and
the <a href="https://communitysolidserver.github.io/CommunitySolidServer/">📓 user documentation</a>
can help you find your way.
There is also a repository of <a href="https://github.com/CommunitySolidServer/tutorials/">📚 comprehensive tutorials</a></p>
<a id="md:📜-license" class="tsd-anchor"></a><h2 class="tsd-anchor-link">📜 License<a href="#md:📜-license" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The Solid Community Server code
is copyrighted by <a href="https://inrupt.com/">Inrupt Inc.</a>
and <a href="https://www.imec-int.com/">imec</a>
and available under the <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/LICENSE.md">MIT License</a>.</p>
<a id="md:🎤-feedback-and-questions" class="tsd-anchor"></a><h2 class="tsd-anchor-link">🎤 Feedback and questions<a href="#md:🎤-feedback-and-questions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Don't hesitate to <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/discussions">start a discussion</a>
or <a href="https://github.com/CommunitySolidServer/CommunitySolidServer/issues">report a bug</a>.</p>
<p>There's also <a href="https://matrix.to/#/#CommunitySolidServer_community:gitter.im">a Matrix-based, CSS-focused chat</a></p>
<p>Learn more about Solid at <a href="https://solidproject.org/">solidproject.org</a>.</p>
</div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:community-solid-server"><span>Community <wbr/>Solid <wbr/>Server</span></a><ul><li><a href="#md:⚡-running-the-community-solid-server"><span>⚡ <wbr/>Running the <wbr/>Community <wbr/>Solid <wbr/>Server</span></a></li><li><a href="#md:🔧-configure-your-server"><span>🔧 <wbr/>Configure your server</span></a></li><li><a href="#md:👩🏽💻-developing-server-code"><span>👩🏽‍💻 <wbr/>Developing server code</span></a></li><li><a href="#md:📜-license"><span>📜 <wbr/>License</span></a></li><li><a href="#md:🎤-feedback-and-questions"><span>🎤 <wbr/>Feedback and questions</span></a></li></ul></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Community Solid Server - v7.1.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
Reference in New Issue View Git Blame Copy Permalink