Skip to content
Snippets Groups Projects
Commit fa5b5f51 authored by Yassine Doghri's avatar Yassine Doghri
Browse files

docs(init): create documentation website using vitepress

- rename podlibre to adaures
- rename castopod-host to castopod
- simplify README and redirect to docs site
- move INSTALL and UPDATE docs
- add new gitlabci pipeline to deploy docs
- upgrade node to v16 in Dockerfile
parent 472842fa
No related branches found
No related tags found
No related merge requests found
Showing
with 817 additions and 785 deletions
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.117.1/containers/docker-existing-dockerfile
{
"name": "Castopod Host dev",
"name": "Castopod dev",
"dockerComposeFile": ["../docker-compose.yml", "./docker-compose.yml"],
"service": "app",
"workspaceFolder": "/castopod-host",
"workspaceFolder": "/castopod",
"postCreateCommand": "composer install && npm install && npm run build:static",
"postStartCommand": "crontab ./crontab && cron && php spark serve --host 0.0.0.0",
"postAttachCommand": "crontab ./crontab && service cron reload",
......
......@@ -4,7 +4,7 @@ services:
volumes:
# Mounts the project folder to '/workspace'. While this file is in .devcontainer,
# mounts are relative to the first file in the list, which is a level up.
- .:/castopod-host:cached
- .:/castopod:cached
# Overrides default command so things don't shut down after the process ends.
command: /bin/sh -c "while sleep 1000; do :; done"
......@@ -2,7 +2,7 @@
# Example Environment Configuration file
#
# This file can be used as a starting point for
# your Castopod Host instance settings.
# your Castopod instance settings.
#
# For manual configuration:
# - copy this file's contents to a file named `.env`
......
......@@ -173,7 +173,7 @@ mariadb
phpmyadmin
sessions
# Castopod Host bundle & packages
castopod-host/
castopod-host-*.zip
castopod-host-*.tar.gz
# Castopod bundle & packages
castopod/
castopod-*.zip
castopod-*.tar.gz
image: code.podlibre.org:5050/podlibre/castopod-host:latest
image: code.castopod.org:5050/ad-aures/castopod:latest
stages:
- prepare
- quality
- bundle
- release
- deploy
php-dependencies:
stage: prepare
......@@ -76,15 +77,15 @@ bundle:
# make scripts/bundle.sh executable
- chmod +x ./scripts/bundle.sh
# bundle castopod-host with commit ref as version
# bundle castopod with commit ref as version
- ./scripts/bundle.sh ${CI_COMMIT_REF_SLUG}_${CI_COMMIT_SHORT_SHA}
dependencies:
- php-dependencies
- js-dependencies
artifacts:
name: "castopod-host-${CI_COMMIT_REF_SLUG}_${CI_COMMIT_SHORT_SHA}"
name: "castopod-${CI_COMMIT_REF_SLUG}_${CI_COMMIT_SHORT_SHA}"
paths:
- castopod-host
- castopod
except:
- main
- beta
......@@ -113,3 +114,12 @@ release:
- main
- beta
- alpha
documentation:
stage: deploy
trigger:
include: docs/.gitlab-ci.yml
strategy: depend
only:
changes:
- docs/**/*
### Before submitting an issue
1. **Use the issue search** — check if the issue has already been
reported.
2. **Check if the issue has been fixed** — try to reproduce it using the
latest release.
3. **Isolate the problem** — ideally create a
[reduced test case](https://css-tricks.com/reduced-test-cases/) and a live
example.
4. **Select an issue template** — choose a template from `bug` or
`feature-request` and fill out the info you deem necessary. The more context
we get, the easier it is to implement the feature or fix the bug you report.
Check out the [CONTRIBUTING manual](../../CONTRIBUTING.md) for more info.
{
"branches": [
"main",
{ "name": "alpha", "prerelease": true },
{ "name": "beta", "prerelease": true }
{
"name": "alpha",
"prerelease": true
},
{
"name": "beta",
"prerelease": true
}
],
"plugins": [
"@semantic-release/commit-analyzer",
......@@ -30,15 +36,15 @@
[
"@semantic-release/gitlab",
{
"gitlabUrl": "https://code.podlibre.org/",
"gitlabUrl": "https://code.castopod.org/",
"assets": [
{
"path": "castopod-host-*.zip",
"label": "Castopod Host Package (zip)"
"path": "castopod-*.zip",
"label": "Castopod Package (zip)"
},
{
"path": "castopod-host-*.tar.gz",
"label": "Castopod Host Package (tar.gz)"
"path": "castopod-*.tar.gz",
"label": "Castopod Package (tar.gz)"
}
]
}
......
# rsync filter rules to copy required files for Castopod Host's bundle
# rsync filter rules to copy required files for Castopod's bundle
- app/Views/_assets/
+ app/***
......@@ -10,6 +10,4 @@
+ .env.example
+ LICENSE.md
+ README.md
+ INSTALL.md
+ UPDATE.md
- **
# Authors
- [Benjamin Bellamy](https://code.podlibre.org/benjamin) <ben@podlibre.org>
- [Yassine Doghri](https://code.podlibre.org/yassine) <yassine@podlibre.org>
- [Benjamin Bellamy](https://code.castopod.org/benjamin) <ben@castopod.org>
- [Yassine Doghri](https://code.castopod.org/yassine) <yassine@castopod.org>
This diff is collapsed.
......@@ -60,7 +60,7 @@ representative at an online or offline event.
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[abuse@podlibre.org](mailto:abuse@podlibre.org). All complaints will be reviewed
[abuse@castopod.org](mailto:abuse@castopod.org). All complaints will be reviewed
and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the
......
# Castopod Host dependencies
# Castopod dependencies
Castopod Host uses the following components:
Castopod uses the following components:
## PHP Dependencies
......
####################################################
# Castopod Host development Docker file
# Castopod development Docker file
####################################################
# ⚠️ NOT optimized for production
# should be used only for development purposes
......@@ -8,8 +8,8 @@ FROM php:8.0-fpm
LABEL maintainer="Yassine Doghri <yassine@doghri.fr>"
COPY . /castopod-host
WORKDIR /castopod-host
COPY . /castopod
WORKDIR /castopod
# Install composer
COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
......@@ -19,7 +19,7 @@ RUN apt-get update \
# gnupg to sign commits with gpg
&& apt-get install --yes --no-install-recommends gnupg \
# npm through the nodejs package
&& curl -fsSL https://deb.nodesource.com/setup_14.x | bash - \
&& curl -fsSL https://deb.nodesource.com/setup_16.x | bash - \
&& apt-get update \
&& apt-get install --yes --no-install-recommends nodejs \
# update npm
......
<h1 align="center">
<a href="https://castopod.org/">
<img src="https://podlibre.org/static/images/Castopod-Title.svg" alt="Castopod Host" />
<img src="https://docs.castopod.org/images/logo-inline.svg" alt="Castopod" />
</a>
</h1>
> **Castopod Host is in beta version**. We are working on getting the last
> features needed for v1, making performance improvements and fixing any bugs
> that may arise along the way.
[![release-badge]][release]&nbsp;[![license-badge]][license]&nbsp;[![semantic-release-badge]][semantic-release]&nbsp;[![discord-badge]][discord]&nbsp;[![stars-badge]][stars]
_Castopod Host_ is a free and open-source podcast hosting solution made for
podcasters who want engage and interact with their audience.
Castopod is a free and open-source podcast hosting solution made for podcasters
who want engage and interact with their audience.
Create, upload, publish, interact with your followers and get comprehensive
audience measurements that respect your listeners privacy.
> Castopod is currently in **beta** but already quite stable and used by
> podcasters around the world!
Whether you choose to install it on your own server or have it hosted by a
professional, all your data and analytics belong to you and you only!
You may find Castopod Host's source code on the
[original repository](https://code.podlibre.org/podlibre/castopod-host) or,
alternatively, on the
[github repository (mirror)](https://github.com/podlibre/castopod-host).
## Install / Update
To install or update Castopod Host on your PHP/MySQL server:
- Download
[Castopod Host's latest Package (zip or tar.gz)](https://code.podlibre.org/podlibre/castopod-host/-/releases):
- Follow one of the procedures on:
## Documentation
- [“How to **install** Castopod Host”](./INSTALL.md)
- or [“How to **update** Castopod Host”](./UPDATE.md)
To get started with Castopod, you may
[check out the documentation](https://docs.castopod.org/), everything should be
there!
## Documentation
## Security issues and vulnerabilities
You can check Castopod Host's documentation for
[setting up a development environment](./docs/setup-development.md).
If you encounter any security issue or vulnerability in the Castopod source,
please contact us directly by email at
[security@castopod.org](mailto:security@castopod.org)
## Contributing
Love Castopod Host and would like to help? Check out the
[contribution guidelines](./CONTRIBUTING.md) for this project, everything should
be there!
Love Castopod and would like to help? Check out the
[contribution guidelines](https://docs.castopod.org/contributing/guidelines) for
this project, everything should be there!
⚠️ Note that **any** contribution made on a repository other than
[the original repository](https://code.podlibre.org/podlibre/castopod-host) will
not be accepted.
[the original repository](https://code.castopod.org/ad-aures/castopod) will not
be accepted.
## Support
## Contact
You may reach us for help or ask any question you have on:
- [Discord](https://castopod.org/discord) (for direct interaction with
developers and the community)
- [Issue tracker](https://code.castopod.org/ad-aures/castopod/-/issues) (for
feature requests & bug reports)
Alternatively, you can follow us on social media platforms to get news about
Castopod:
- [podlibre.social](https://podlibre.social/@Castopod) (Mastodon instance)
- [Twitter](https://twitter.com/castopod)
- [LinkedIn](https://linkedin.com/company/castopod)
- [Facebook](https://www.facebook.com/castopod)
## Sponsors
[Castopod](https://nlnet.nl/project/Castopod/) was funded through the
[NGI0 Discovery](https://nlnet.nl/discovery/) Fund under grant agreement
Nº 825322.
The fund was established by NLnet with financial support from the European
Commission's [Next Generation Internet](https://www.ngi.eu/) programme, under
the aegis of DG Communications Networks, Content and Technology.
<div style="display:flex;flex-wrap:wrap;column-gap:4rem;row-gap:2rem;">
<a href="https://adaures.com/" target="_blank" rel="noopener noreferrer"><img src="https://docs.castopod.org/images/sponsors/adaures.svg" alt="Ad Aures Logo" style="height:4rem;" /></a>
<a href="https://nlnet.nl/project/Castopod/" target="_blank" rel="noopener noreferrer"><img src="https://docs.castopod.org/images/sponsors/adaures.svg" alt="NLnet Logo" style="height:4rem;" /></a>
<a href="https://opencollective.com/castopod/contribute" target="_blank" rel="noopener noreferrer">Become a sponsor</a>
</div>
[release]: https://code.castopod.org/ad-aures/castopod/-/releases
[release-badge]:
https://img.shields.io/gitlab/v/release/2?color=brightgreen&gitlab_url=https%3A%2F%2Fcode.castopod.org%2F&include_prereleases&label=release
[license]: https://code.castopod.org/ad-aures/castopod/-/blob/beta/LICENSE.md
[license-badge]:
https://img.shields.io/github/license/ad-aures/castopod?color=blue
[semantic-release]: https://github.com/semantic-release/semantic-release
[semantic-release-badge]:
https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[discord]: https://castopod.org/discord
[discord-badge]: https://img.shields.io/badge/chat-on%20discord-7389D8
[stars]: https://github.com/ad-aures/castopod/stargazers
[stars-badge]:
https://img.shields.io/github/stars/ad-aures/castopod?style=social
......@@ -437,7 +437,7 @@ class App extends BaseConfig
public string $siteTitleSeparator = ' | ';
public string $siteDescription = 'Castopod Host is an open-source hosting platform made for podcasters who want engage and interact with their audience.';
public string $siteDescription = 'Castopod is an open-source hosting platform made for podcasters who want engage and interact with their audience.';
/**
* @var array<int|string, string>
......
......@@ -3,7 +3,7 @@
declare(strict_types=1);
/**
* @copyright 2022 Podlibre
* @copyright 2022 Ad Aures
* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
* @link https://castopod.org/
*/
......
......@@ -3,7 +3,7 @@
declare(strict_types=1);
/**
* @copyright 2021 Podlibre
* @copyright 2021 Ad Aures
* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
* @link https://castopod.org/
*/
......
......@@ -3,7 +3,7 @@
declare(strict_types=1);
/**
* @copyright 2020 Podlibre
* @copyright 2020 Ad Aures
* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
* @link https://castopod.org/
*/
......
......@@ -3,7 +3,7 @@
declare(strict_types=1);
/**
* @copyright 2020 Podlibre
* @copyright 2020 Ad Aures
* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
* @link https://castopod.org/
*/
......
......@@ -3,7 +3,7 @@
declare(strict_types=1);
/**
* @copyright 2020 Podlibre
* @copyright 2020 Ad Aures
* @license https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
* @link https://castopod.org/
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment