Updated main links in docs to use peertube instead of YouTube.
Not so fussed about leaving old blog/other YT links in though, just
better that if we're providing guidance we're leading folks to an
ad-free privacy respecting zone.
The webhook data is "Slack Compatible" in respect to having a `text` property containing a human-readable description
of the event. Services such as [Discord](https://discord.com/developers/docs/resources/webhook#execute-slackcompatible-webhook), [Zulip](https://zulip.com/integrations/doc/slack_incoming) and Teams, upon many others, have options to support this format.
-A video guide on BookStack webhooks, including usage with Discord and HomeAssistant, [can be found here](https://www.youtube.com/watch?v=_zIp1ruGpoI).
+A video guide on BookStack webhooks, including usage with Discord and HomeAssistant, [can be found here](https://foss.video/w/xu4T7mafyLqkLU1VTgNaCV).
The running of webhooks can slow down a system due to the required additional processing time.
See the [async action handling](#async-action-handling) section below to details on running webhooks
A script to install BookStack on a fresh instance of Ubuntu 22.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP 8.1 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
- [Link to installation script](https://github.com/BookStackApp/devops/blob/main/scripts/installation-ubuntu-22.04.sh)
-- [Video guide](https://www.youtube.com/watch?v=wq78komr9rs)
+- [Video guide](https://foss.video/w/emk5bMzhRdk4qzDoq3R6xe)
#### Running the Script
A script to install BookStack on a fresh instance of Ubuntu 20.04 is available. This script is ONLY FOR A FRESH OS, it will install Apache, MySQL 8.0 & PHP 8.2 and could OVERWRITE any existing web setup on the machine. It also does not set up mail settings or configure system security so you will have to do those separately. You can use the script as a reference if you're installing on a non-fresh machine.
- [Link to installation script](https://github.com/BookStackApp/devops/blob/main/scripts/installation-ubuntu-20.04.sh)
-- [Video guide](https://www.youtube.com/watch?v=ShqUjt33uOs)
+- [Video guide](https://foss.video/w/59udkzBf8ftVPWutkBcuyM)
#### Running the Script
* [Sample Docker Swarm Stack by @neuroforgede](https://github.com/neuroforgede/bookstack-docker-swarm)
In addition to written guides, there are a bunch [community videos on YouTube](https://www.youtube.com/playlist?list=PLLIji4SLo6EiAUI5X3amBSB99HpabUqsS)
-in addition to the [guides on the official BookStack channel](https://www.youtube.com/playlist?list=PLLIji4SLo6EidqlySHJNGyQ_rLpMY3nmE).
+in addition to the guides on the official [BookStack YouTube channel](https://www.youtube.com/c/BookStackApp)
+or [BookStack PeerTube channel](https://foss.video/c/bookstack/).
#### Old Guides
BookStack can be configured to allow LDAP based user login. While LDAP login is enabled you cannot log in with the standard user/password login and new user registration is disabled. BookStack will only use the LDAP server for getting user details and for authentication. Data on the LDAP server is not editable through BookStack.
-[A video guide for setting up LDAP can be found here](https://www.youtube.com/watch?v=50qw_LkhwoM).
+[A video guide for setting up LDAP can be found here](https://foss.video/w/3jKDj5DpF4tqUtx9HhweNM).
### Authentication Setup
We have a range of videos available that can help show, for a range of identity platforms, the exact steps required to set-up a BookStack OpenID Connect authentication integration:
-- [General setup guide (Using Okta as an example)](https://www.youtube.com/watch?v=TJQ4NJrMvkw)
-- [Azure Active Directory OIDC Guide](https://www.youtube.com/watch?v=CL5kMFkopHY)
-- [Authentik BookStack OIDC Guide](https://www.youtube.com/watch?v=M1_WPhR4hRc)
+- [General setup guide (Using Okta as an example)](https://foss.video/w/1b6sc98un7ugGv98v9UaRC)
+- [Azure Active Directory OIDC Guide](https://foss.video/w/n67qNijhf8BdTRQys8SDYf)
+- [Authentik BookStack OIDC Guide](https://foss.video/w/a744K8GxFF1LqBFSadAsuV)
### Requirements & Limitations
BookStack can be configured to utilise a SAML 2.0 based authentication provider as a solution for users to log-in, log-out and self-register within BookStack. This replaces the default email & password authentication mechanism within BookStack. When enabled, BookStack will attempt to match the SAML user to an existing BookStack user based on a stored external id attribute otherwise, if not found, BookStack will effectively auto-register that user to provide a seamless access experience.
-[A video guide for setting up SAML2 can be found here](https://www.youtube.com/watch?v=szweYsAow88).
+[A video guide for setting up SAML2 can be found here](https://foss.video/w/jJGmXS8sK244YFgogAz8LP).
### BookStack Configuration
<li><a href="https://discord.gg/ztkBqR2" target="_blank">Discord</a></li>
<li><a href="https://twitter.com/bookstack_app" target="_blank">Twitter</a></li>
<li><a rel="me" href="https://fosstodon.org/@bookstack" target="_blank">Mastodon</a></li>
- <li><a href="https://www.youtube.com/channel/UCH66RFWfw6CSm2T1EM4ik1g" target="_blank">YouTube</a></li>
+ <li><a href="https://foss.video/c/bookstack/" target="_blank">PeerTube</a></li>
+ <li><a href="https://www.youtube.com/c/BookStackApp" target="_blank">YouTube</a></li>
<li><a href="https://www.reddit.com/r/bookstack" target="_blank">Reddit</a></li>
</ul>
</div>
<p>Provide financial support to the project</p>
</div>
</a>
+ <a href="https://foss.video/c/bookstack/" target="_blank" class="nav-dropdown-item">
+ <div class="nav-dropdown-item-icon" aria-hidden="true">{{partial "icon/peertube.svg"}}</div>
+ <div>
+ <div class="nav-dropdown-item-title">Videos on PeerTube</div>
+ <p>Find our video guides on the fediverse.</p>
+ </div>
+ </a>
<a href="https://www.youtube.com/c/BookStackApp" target="_blank" class="nav-dropdown-item">
<div class="nav-dropdown-item-icon" aria-hidden="true">{{partial "icon/youtube.svg"}}</div>
<div>
- <div class="nav-dropdown-item-title">Video Guides</div>
+ <div class="nav-dropdown-item-title">Guides on YouTube</div>
<p>Watch our video guides on YouTube</p>
</div>
</a>
--- /dev/null
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 6.35 6.35">
+ <path d="M.9924.26455v2.9104l2.18275-1.45511M.9924 3.17495v2.9104l2.18275-1.45511m0-2.91057v2.9104l2.18276-1.45512"/>
+</svg>
<div class="container">
<div class="row">
<div class="col-md-6">
- <h3>Our Guides on YouTube</h3>
+ <h3>Video Guides</h3>
<p>
If you prefer videos to text, or need a bit of visual guidance,
- our YouTube channel hosts a series of videos that cover installation,
+ we're on both YouTube and PeerTube where we host a series of videos that cover installation,
configuration, maintenance and usage.
</p>
<p>
- <a href="https://www.youtube.com/channel/UCH66RFWfw6CSm2T1EM4ik1g" target="_blank"
- rel="noopener">View our channel here »</a>
+ <a href="https://foss.video/c/bookstack/" target="_blank"
+ rel="noopener">Our PeerTube channel</a>
+ <span class="text-muted"> | </span>
+ <a href="https://www.youtube.com/c/BookStackApp" target="_blank"
+ rel="noopener">Our YouTube channel</a>
</p>
</div>
<div class="col-md-6">
projects / website / commitdiff
