saulteafarmer/castopod
1
0
Fork 0
mirror of https://code.castopod.org/adaures/castopod synced 2025-04-19 13:01:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add user guide section

Browse Source
This commit is contained in:
Paul Cutler 2024-11-06 11:40:28 +00:00 committed by Yassine Doghri
parent 3b90c5b5bd
commit be1d8c4876
22 changed files with 3592 additions and 2827 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

107
docs/astro.config.mjs
View File

@ -181,6 +181,113 @@ export default defineConfig({
"nn-no": "Autentisering",
},
},
{
label: "Create your first podcast",
link: "/getting-started/create-podcast/",
translations: {},
},
{
label: "Create your first episode",
link: "/getting-started/create-episode/",
translations: {},
},
],
},
{
label: "User guide",
translations: {},
items: [
{
label: "Introduction",
link: "/user-guide/",
},
{
label: "Manage your instance",
translations: {},
items: [
{
label: "Introduction",
link: "/user-guide/instance/",
},
{
label: "Add a podcast",
link: "/user-guide/instance/add-podcast",
translations: {},
},
{
label: "Persons",
link: "/user-guide/instance/persons",
translations: {},
},
{
label: "Fediverse",
link: "/user-guide/instance/fediverse",
translations: {},
},
{
label: "Users",
link: "/user-guide/instance/users",
translations: {},
},
{
label: "Pages",
link: "/user-guide/instance/pages",
translations: {},
},
{
label: "Settings",
link: "/user-guide/instance/settings",
translations: {},
},
],
},
{
label: "Manage your podcasts",
translations: {},
items: [
{
label: "Introduction",
link: "/user-guide/podcast/",
},
{
label: "Podcast dashboard",
link: "/user-guide/podcast/dashboard",
translations: {},
},
{
label: "Episodes",
link: "/user-guide/podcast/episodes",
translations: {},
},
{
label: "Analytics",
link: "/user-guide/podcast/analytics",
translations: {},
},
{
label: "Broadcasting",
link: "/user-guide/podcast/broadcast",
translations: {},
},
{
label: "Monetization",
link: "/user-guide/podcast/monetization",
translations: {},
},
{
label: "Contributors",
link: "/user-guide/podcast/contributors",
translations: {},
},
],
},
{
label: "Website overview",
link: "/user-guide/website/",
translations: {},
},
],
},
],

26
docs/package.json
View File

@ -11,18 +11,18 @@
"prepare": "astro telemetry disable"
},
"dependencies": {
"@astrojs/check": "^0.7.0",
"@astrojs/starlight": "^0.22.4",
"@astrojs/starlight-tailwind": "^2.0.2",
"@astrojs/tailwind": "^5.1.0",
"@fontsource/inter": "^5.0.18",
"@fontsource/rubik": "^5.0.20",
"astro": "^4.8.6",
"autoprefixer": "^10.4.19",
"cssnano": "^7.0.1",
"postcss-preset-env": "^9.5.13",
"sharp": "^0.33.4",
"tailwindcss": "^3.4.3",
"typescript": "^5.4.5"
"@astrojs/check": "^0.9.4",
"@astrojs/starlight": "^0.28.6",
"@astrojs/starlight-tailwind": "^2.0.3",
"@astrojs/tailwind": "^5.1.2",
"@fontsource/inter": "^5.1.0",
"@fontsource/rubik": "^5.1.0",
"astro": "^4.16.9",
"autoprefixer": "^10.4.20",
"cssnano": "^7.0.6",
"postcss-preset-env": "^10.0.9",
"sharp": "^0.33.5",
"tailwindcss": "^3.4.14",
"typescript": "^5.6.3"
}
}

5340
docs/pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff

13
docs/src/components/Header.astro
View File

@ -2,17 +2,18 @@
import config from 'virtual:starlight/user-config';
import type { Props } from '@astrojs/starlight/props';
import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
import Search from 'virtual:starlight/components/Search';
import SiteTitle from 'virtual:starlight/components/SiteTitle';
import SocialIcons from 'virtual:starlight/components/SocialIcons';
import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
import LanguageSelect from '@astrojs/starlight/components/LanguageSelect.astro';
import Search from '@astrojs/starlight/components/Search.astro';
import SiteTitle from '@astrojs/starlight/components/SiteTitle.astro';
import SocialIcons from '@astrojs/starlight/components/SocialIcons.astro';
import ThemeSelect from '@astrojs/starlight/components/ThemeSelect.astro';
import VersionSelect from './DocsVersionSelect.astro';
/**
* Render the `Search` component if Pagefind is enabled or the default search component has been overridden.
*/
const shouldRenderSearch =
const shouldRenderSearch =
config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro';
---

6
docs/src/components/MobileMenuFooter.astro
View File

@ -1,7 +1,7 @@
---
import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
import SocialIcons from 'virtual:starlight/components/SocialIcons';
import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
import LanguageSelect from '@astrojs/starlight/components/LanguageSelect.astro';
import SocialIcons from '@astrojs/starlight/components/SocialIcons.astro';
import ThemeSelect from '@astrojs/starlight/components/ThemeSelect.astro';
import type { Props } from '@astrojs/starlight/props';
import VersionSelect from './DocsVersionSelect.astro';
---

81
docs/src/content/docs/en/getting-started/create-episode.mdx Normal file
View File

@ -0,0 +1,81 @@
---
title: Create your first episode
---
To add an episode to your podcast, choose Podcasts -> All podcasts from your instance management left hand sidebar.
Then choose Podcast dashboard and press the Add an episode button in the upper right hand corner and fill out the
following fields.
## Episode Info
### Audio file
Press the `Choose File` button to select the audio file to upload to Castopod. The audio file must be an mp3 or m4a
file and cannot be larger than 512 megabytes.
### Episode cover
You can optionally add a different podcast cover / artwork. Press `Choose File` and select an image from your computer
that must be at least 1400px wide and tall and no larger than 3000px wide and tall. If you do not choose an
episode cover, your default podcast artwork will be used.
### Title
Enter the name for your new episode. Do not add the season or episode number in the **Title** field. Choose a clear
and concise episode name to help your listeners.
### Permalink
The permalink is the link to the public episode page. This will be automatically filled out based on the title
you entered above. If you wish to have a different permalink, press the edit button to the right of the
displayed permalink.
### Season and Episode
You can optionally add a season and / or episode number to your episode.
## Show Notes
Describe your episode in detail. You can use up to 4000 characters, and you can use Markdown to style your show
notes. You can expand the text box by pressing and holding the bottom right corner of the text box.
When your show notes are complete, press `Preview` to view how your show notes will be displayed.
## Additional Files
### Transcripts
You can add a transcript to your episode by choosing a file in SRT or VTT format to upload. Transcripts will be
shown in a tab on the episode page and some podcast apps such as Apple Podcasts can display the transcript.
Transcripts help users who may have a hearing disability and can also help with search engine optimization.
### Chapters
You can optionally upload a chapters file in JSON format. To learn more about chapters and for an example of the
correct format, visit the [Podcast Namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md).
!!! note
Not all podcast players natively support chapters in JSON format. More modern players, such as Fountain and
Apple Podcasts, do support chapters in JSON format.
## Publish your episode
When complete, press the `Create episode` button at the bottom of the page. You will be automatically directed to
the next step to publish your episode. Your episode is in draft mode and is not yet published. You can preview
how your episode will look when published or publish your episode. To publish your episode, press the `Publish` button
in the upper right hand corner.
### Create your announcement post
After pressing `Publish` you will be directed to the next page to draft your announcement post. Write your message
in the text box provided. This will be the message broadcast to the Fediverse and published on your podcast's home
page.
### Publication date
Choose `Now` or `Schedule` to publish your episode. If you choose `Now`, your episode will be live. Or you can
schedule the day and time to publish your episode by choosing the `Schedule` radio button and choosing the day and
time. Press `Publish` to finish.
Your RSS feed will be automatically updated with your episode information and listeners who subscribe will be
notified of a new episode. Congratulations on publishing your first episode!

114
docs/src/content/docs/en/getting-started/create-podcast.mdx Normal file
View File

@ -0,0 +1,114 @@
---
title: Create your first podcast
---
import { Aside } from "@astrojs/starlight/components";
From the left hand navigation sidebar, press the `+` sign to the right of Podcasts to create your first podcast.
## Podcast Identity
### Podcast Cover
To upload your podcast cover art, press the `Choose File` button and choose your cover art from your computer. The
cover art needs to be in JPG or PNG format and a minimum of 1400px wide and tall with a maximum of 3000px wide and
tall.
### Title
Enter the name of your podcast in the **Title** field.
### Description
Describe what your podcast is about. You can use Markdown to style the text and you can resize the text box by
pressing and holding the bottom right hand corner of the text box.
### Type
Choose how your listeners should listen to your podcast. **Episodic** lets listeners know they can consume your podcast
in any order, such as an interview podcast. Choose **Serial** if your episodes are meant to be listened to in
sequential order.
### Medium
Choose the type of audio for your podcast:
- **Podcast**: a standard podcast.
- **Music**: A feed of music organized into an "album" with each item a song within the album.
- **Audiobook**: A specific type of audio with one item per feed, or where items represent chapters within a book.
## Classification
### Language
From the dropdown menu, choose which language is spoken in your podcast.
### Category
Choose the category that represents your podcast, such as Arts, Comedy, Sports, Technology, etc.
### Other categories (optional)
You can choose a second category in addition to the main category you set up.
### Parental advisory
Choose if your podcast has explicit content or swearing or choose Clean if your podcast is suitable for everyone. You
can also choose to leave this category as undefined. When [creating a new episode](../podcast/episodes.md),
you will also have the opportunity to choose clean, explicit, or undefined on a per episode basis.
## Author
### Owner name and email
Enter the owner name and email in the provided fields. This is only visible in the RSS feed and is used by other
podcasting platforms to verify your ownership of your podcast. You can choose to remove the owner email
from the public RSS feed by using the provided toggle.
### Publisher
If your podcast is part of a podcast network or is produced by a company, enter the publisher here.
### Copyright
You can optionally add the copyright holder in this field.
### Fediverse identity
Enter the handle (or nickname) for your podcast. This will allow people on Mastodon and other Fediverse services
to follow your podcast. Your handle will be shown as @yourdomain.com@handle on the Fediverse.
To learn more about Fediverse integration, visit the [Fediverse documentation page](../instance/fediverse.md).
### Podcast banner
Upload a banner image to be displayed at the top of your podcast's home page. The banner must have a 3:1 ration and
be at least 1500px wide.
### Premium
Toggle this setting to set all episodes by default as premium. When creating an episode, it will default to premium,
and you can still choose to make some episodes, trailers, or bonus content as free and public.
## Open Podcast Prefix Project (OP3)
The [Open Podcast Prefix Project](https://op3.dev) is an open source and trusted third party analytics service. If
you toggle this to enabled, you will be able to view analytics for your podcast over time including the number of
listens over time, episode comparison charts, and more.
## Location
You can optionally add a real or fictitious location name in this field. When
[creating a new episode](../podcast/episodes.md) you also can add a location to an individual episode.
## Advanced Parameters
You can optionally toggle the following settings:
- **Prevent podcast from being copied**: this locks your podcast and does not allow other podcast platforms to import
your podcast. If you decide in the future to migrate away from Castopod to a new platform, this toggle will need to be
unchecked.
- **Podcast should be hidden from public catalogues**: If toggled, a best effort is made to hide the entire podcast from
appearing in Apple Podcasts, YouTube Music, and any other third party podcast apps. (Not guaranteed)
- **Podcast will not be having new episodes**: If your podcast comes to an end, you can toggle this to let listeners
know there will not be new episodes.

13
docs/src/content/docs/en/user-guide/index.mdx Normal file
View File

@ -0,0 +1,13 @@
---
title: Welcome to the Castopod User Guide
---
import { LinkCard, CardGrid } from "@astrojs/starlight/components";
Welcome to the Castopod User Guide. This guide is divided into three parts:
<CardGrid>
<LinkCard title="Managing your instance" href="instance" />
<LinkCard title="Managing your podcasts" href="podcast" />
<LinkCard title="Website overview" href="website" />
</CardGrid>

145
docs/src/content/docs/en/user-guide/instance/add-podcast.mdx Normal file
View File

@ -0,0 +1,145 @@
---
title: Create or import a podcast
---
You can create a new podcast or import an existing podcast into Castopod in the Podcasts section. If you are adding
a second podcast to Castopod, see the [Home page documentation](../website/home.md) for how that will change your
home page.
From the left hand navigation sidebar, press the `+` sign to the right of Podcasts to create your first podcast.
## Podcast Identity
### Podcast Cover
To upload your podcast cover art, press the `Choose File` button and choose your cover art from your computer. The
cover art needs to be in JPG or PNG format and a minimum of 1400px wide and tall with a maximum of 3000px wide and
tall.
### Title
Enter the name of your podcast in the **Title** field.
### Description
Describe what your podcast is about. You can use Markdown to style the text and you can resize the text box by
pressing and holding the bottom right hand corner of the text box.
### Type
Choose how your listeners should listen to your podcast. **Episodic** lets listeners know they can consume your podcast
in any order, such as an interview podcast. Choose **Serial** if your episodes are meant to be listened to in
sequential order.
### Medium
Choose the type of audio for your podcast:
- **Podcast**: a standard podcast.
- **Music**: A feed of music organized into an "album" with each item a song within the album.
- **Audiobook**: A specific type of audio with one item per feed, or where items represent chapters within a book.
## Classification
### Language
From the dropdown menu, choose which language is spoken in your podcast.
### Category
Choose the category that represents your podcast, such as Arts, Comedy, Technology, etc.
### Other categories (optional)
You can choose a second category in addition to the main category you set up.
### Parental advisory
Choose if your podcast has explicit content or swearing or choose Clean if your podcast is suitable for everyone. You
can also choose to leave this category as undefined. When [creating a new episode](../podcast/episodes.md),
you will also have the opportunity to choose clean, explicit, or undefined on a per episode basis.
## Author
### Owner name and email
Enter the owner name and email in the provided fields. This is only visible in the RSS feed and is used by other
podcasting platforms to verify your ownership of your podcast. You can choose to remove the owner email
from the public RSS feed by using the provided toggle.
### Publisher
If your podcast is part of a podcast network or is produced by a company, enter the publisher here.
### Copyright
You can optionally add the copyright holder in this field.
### Fediverse identity
Enter the handle (or nickname) for your podcast. This will allow people on Mastodon and other Fediverse services
to follow your podcast. Your handle will be shown as @yourdomain.com@handle on the Fediverse.
To learn more about Fediverse integration, visit the [Fediverse documentation page](../instance/fediverse.md).
### Podcast banner
Upload a banner image to be displayed at the top of your podcast's home page. The banner must have a 3:1 ration and
be at least 1500px wide.
### Premium
Toggle this setting to set all episodes by default as premium. When creating an episode, it will default to premium,
and you can still choose to make some episodes, trailers, or bonus content as free and public.
## Open Podcast Prefix Project (OP3)
The [Open Podcast Prefix Project](https://op3.dev) is an open source and trusted third party analytics service. If
you toggle this to enabled, you will be able to view analytics for your podcast over time including the number of
listens over time, episode comparison charts, and more.
## Location
You can optionally add a real or fictitious location name in this field. When
[creating a new episode](../podcast/episodes.md) you also can add a location to an individual episode.
## Advanced Parameters
You can optinally toggle the following settings:
- **Prevent podcast from being copied**: this locks your podcast and does not allow other podcast platforms to import
your podcast. If you decide in the future to migrate away from Castopod to a new platform, this toggle will need to be
unchecked.
- **Podcast should be hidden from public catalogues**: If toggled, a best effort is made to hide the entire podcast from
appearing in Apple Podcasts, YouTube Music, and any other third party podcast apps. (Not guaranteed)
- **Podcast will not be having new episodes**: If your podcast comes to an end, you can toggle this to let listeners
know there will not be new episodes.
## Import an existing podcast
When importing a podcast, make sure you own the rights for this podcast before importing it.
Copying and broadcasting a podcast without the proper rights is piracy and is liable to prosecution.
### Import the podcast
To import a podcast, enter the podcast's **Feed URL**. The feed must be in XML or RSS format. You may want to validate
the feed to make sure there are no errors in the RSS or XML feed prior to importing as errors may cause the import
to fail. One popular feed validator is [Cast Feed Validator](https://www.castfeedvalidator.com) from
Blubrry Podcasting.
### Podcast information
Enter the handle for your podcast. This will be part of the URL for others to interact with your podcast on the
Fediverse. It will be yourdomain.com@nameofyourpodcast.
Choose the language your podcast is recorded in from the drop down box.
Lastly, choose the Category of your podcast, such as Sports, Technology, Arts, etc.
When complete, click Add import to queue. You will then be redirected to a Podcast imports page to view the status
of the import. You can refresh the page to see the status of the import including the import duration and how many
episodes were imported when complete.
!!! note
If your import times out, check your `max_execution_time` in your `PHP.ini` file. You may need to increase it
from 30 seconds (the default) to add more time, such as 300 seconds (5 minutes) for larger podcasts.

35
docs/src/content/docs/en/user-guide/instance/fediverse.mdx Normal file
View File

@ -0,0 +1,35 @@
---
title: Fediverse
---
## What is the Fediverse?
Wikipedia defines the Fediverse as:
> The fediverse is a collection of social networking services that can communicate with each other using a common
> protocol, ActivityPub. Users of different websites can send and receive status updates, multimedia files and other
> data across the network.
Your podcast is connected to the Fediverse and, for example, Mastodon users can subscribe to your handle and will
receive a message every time your podcast publishes a new episode. You can also broadcast messages to your followers
on the Fediverse from your [home page](../website/home.md). Mastodon users can like and share your posts.
## Manage Fediverse Blocks
You can block a Fediverse user or an entire domain to help stop harassment or spam.
### Blocked Accounts
To block a specific Fediverse user, enter the user's handle in the **Account Handle** text box. It should be in
the format of @user@domain.com. Press `Block` to block the user from following your podcast.
A list of all blocked accounts is shown below the **Account Handle** text box. You can choose to unblock a user
by pressing the `Unblock` button.
### Blocked Domains
To block an entire domain, enter the domain name such as `www.example.com` in the **Domain Name** field and press
`Block`.
A list of all blocked domains is shown below the **Domain Name** text box. You can choose to unblock a domain
by pressing the `Unblock` button.

32
docs/src/content/docs/en/user-guide/instance/index.mdx Normal file
View File

@ -0,0 +1,32 @@
---
title: Managing your instance
---
import { LinkCard, CardGrid } from "@astrojs/starlight/components";
## What is an instance?
Your podcast is hosted on your sever and connected to the [Fediverse](fediverse) in what is called an _instance_.
Your instance can manage multiple podcasts, people and users, and host additional pages found on all of your podcasts.
Managing your instance, including podcasts, people, and users is separate from the settings for each
individual podcast.
## Ready to get started?
Learn more about adding podcasts, users, and more by clicking one of the links below.
<CardGrid>
<LinkCard title="Create or import a podcast" href="podcast" />
<LinkCard
title="Manage the people involved with your podcast"
href="persons"
/>
<LinkCard title="Manage Fediverse integration" href="fediverse" />
<LinkCard
title="Manage users who can access the admin interface"
href="users"
/>
<LinkCard title="Add additional web pages" href="pages" />
<LinkCard title="Manage settings" href="settings" />
</CardGrid>

28
docs/src/content/docs/en/user-guide/instance/pages.mdx Normal file
View File

@ -0,0 +1,28 @@
---
title: Pages
---
## Add Pages
You can add static pages linked from your podcast's home page. From the left hand navigation, choose the `+` sign or
click `Pages` -> `New Page`.
### Title
In the **Title** text box, enter the name for the page you are adding.
### Permalink
In the `Permalink` text box, enter the permalink if you want it different than the title.
### Content
You can add your page content in the **Content** text box. You can use Markdown to style your text.
When finished, press the `Create page` button. You can view your page from your podcast's home page. It will be
linked in the right hand side bar navigation.
## Delete or Edit a Page
After adding a page, you can delete the page or edit it by choosing `Pages` -> `All Pages` from the instance
navigation sidebar on the left. Press the corresponding button to view the page, edit it, or delete it.

22
docs/src/content/docs/en/user-guide/instance/persons.mdx Normal file
View File

@ -0,0 +1,22 @@
---
title: Manage Podcast contributors
---
The **Persons** section allows you to add podcast contributors. It is needed in the Podcast section to assign
roles and is also used on the **Credits** page linked from your podcast's homepage.
From the left hand navigation, press `Persons` to expand the menu. To view a list of all people that have been
added to Castopod, press `All Persons`.
## Add a person
To add a person, press `New Person` from the left hand sidebar or press `Create a person` from the upper right hand
corner of the **All Persons** page and fill out the following fields:
- **Avatar**: You can optionally add a picture or avatar of the person. Press `Choose File` and upload a picture
from your computer. It must be at least 400px wide and tall.
- **Full Name**: Enter the name as you want it displayed on your website.
- **Unique Name**: Enter a unique username for the person you are adding. This will be displayed in the Podcasts
secton when assigning this person a role.
- **Information URL**: Enter a URL for the person's homepage, profile, or social media account to be linked from the
[Credits page](../website/credits.md).

49
docs/src/content/docs/en/user-guide/instance/settings.mdx Normal file
View File

@ -0,0 +1,49 @@
---
title: Settings
---
To change or update the settings for your instance, choose `Settings` from the left hand navigation.
## General settings
### Instance
#### Site Name
Update the name of your instance in the `Site name` text field.
#### Site Description
Update description of your instance in the `Site description` text box.
#### Site icon
You can upload a site icon, also known as a favicon, by pressing `Choose file`. Site icons are what you see
on your browser tabs, bookmarks, and shortcuts on mobile devices. The image must be at least 500px tall and wide.
### Images
If you come across broken or missing images on your site, press `Regenerate images`. This process may take time.
### Housekeeping
You can run various tasks for your instance:
- **Reset counts**: This will reset and recalculate counts for followers, posts, and comments.
- **Rename episode files**: This option renames all episodes files to a random name. If one of your private
episodes leaks, toggle this setting to effectively hide the episode.
- **Clear all cache**: This option will flush the Redis cache or writable / cache files.
## Theme
You can choose one of six accent colors for your public pages.
## About
This shows general information about your instance including:
- Host name (typically your domain name)
- Castopod version
- PHP version
- Operating System
- Available languages

16
docs/src/content/docs/en/user-guide/instance/users.mdx Normal file
View File

@ -0,0 +1,16 @@
---
title: Users
---
Roles and permissions in Castopod are defined in two ways, **Instance** users and
[**Podcast**. contributors](../podcast/contributors.md). For a detailed list of permissions, view
he [Auth](/docs/en/getting-started/auth) page.
## Adding a User to the instance
You can add a user to your instance by choosing `Users` -> `New User` from the left hand navigation menu. There
are three roles you can assign to an instance user:
- **Super Admin**: This user has complete control over Castopod including adding or removing podcasts or users.
- **Manager**: This user can manage Castopod's content, such as adding or importing a new podcast and managing people.
- **Podcaster**: This is for general users of Castopod who can access the admin interface.

55
docs/src/content/docs/en/user-guide/podcast/analytics.mdx Normal file
View File

@ -0,0 +1,55 @@
---
title: Analytics
---
Castopod comes with a number of different analytics and statistics about your podcast(s). From the left hand
navigation, choose `Analytics` to view the various options.
## Audience overview
This page provides an overview of your episode's daily downloads, monthly downloads, and daily bandwidth used.
## Unique listeners
View graphs of the number of daily and monthly users of your podcast. Use the zoom function at the top of each
graph to zoom in or out.
## Listening time
View graphs of your listener's daily and monthly cumulative listening time. Use the zoom function at the top of each
graph to zoom in or out.
## Players
This page provides four pie charts to view statistics for the last week:
- Episode downloads by player
- Episode downloads by service
- Episode downloads by device
- Episode downloads by operating system
You can hover over each graph and press the three dots to download statistics for the graph you are hovering over.
You can interact with the graphs to download or print:
- Image (PNG, JPG, SVG, or PDF)
- Data (JSON, CSV, XLSX, HTML, or PDF)
- Print
## Locations
You can view where your listeners are located by choosing _Locations_. Two pie charts are available showing
episode downloads by country for the past week and past year. At the bottom of the page, you can view a world map
showing your listener's locations.
## Time periods
Two bar graphs displaying the week day and time of day your listeners listen to your podcsat.
## Web pages visits
You can view four pie charts showing information about web page visits:
- Web page visits by source (for the past week)
- Web page visits by source (for the past year)
- Web page visits by landing page
- Web page visits by browser

34
docs/src/content/docs/en/user-guide/podcast/broadcast.mdx Normal file
View File

@ -0,0 +1,34 @@
---
title: Broadcast your podcast
---
## Add your podcast to podcast directories
Listeners can add your RSS feed to their podcast app of choice to subscribe to your podcast. Most listeners will
find your podcast in a podcast directory, such as Apple Podcasts, YouTube Music, Spotify, or the Podcast Index.
These four are the most popular podcast directories and a number of other directories pull their data from Apple
Podcasts.
Visit [Podnews](https://podnews.net/article/all-the-podcast-directories) to learn how to add your podcast to
most of the podcast directories.
Once your podcast is listed in the podcast directories, you can link to them on your home page by choosing
`Broadcast` from the left hand navigation.
### Podcasting Apps
Castopod provides the ability to link to a majority of podcast directories where users can find your podcast.
For each directory listed fill out the link to your podcast in a specific directory and the ID. If you want
an icon displayed on your home page, toggle `Display in podcast homepage?`.
After pressing `Save` in the upper right hand corner, visit your home page to see the icons with hyperlinks
on the right hand side of your home page under _Listen on_.
### Social Networks
If your podcast has a presence on social networks, Castopod provides the ability to link to your social network
profiles. Add the link to your profile page in the text field and toggle if you want it displayed on your
home page.
After pressing `Save` in the upper right hand corner, visit your home page to see the icons with hyperlinks
on the right hand side of your home page under _Find your podcast on_.

28
docs/src/content/docs/en/user-guide/podcast/contributors.mdx Normal file
View File

@ -0,0 +1,28 @@
---
title: Contributors
---
From the podcast dashboard, click **Contributors** to add or edit users to have access to the podcast and its settings.
For a detailed list of permissions, view the [Auth](/docs/en/getting-started/auth) page.
## Roles
There are four roles you can assign a person to help manage your podcast.
### Admin
The admin user has complete control over the individual podcast.
### Editor
The editor has access to management functions including podcast import, managing persons, creating or deleting
episodes, and managing clips.
### Author
The autorh can manage content of the podcast, but cannot publish an episode. They can manage
[contributors](contributors), create clips, and create episodes.
### Guest
The guest can view the podcast dashboard and view episodes. They cannot edit or add any content.

50
docs/src/content/docs/en/user-guide/podcast/dashboard.mdx Normal file
View File

@ -0,0 +1,50 @@
---
title: Podcast Dashboard
---
When you choose your podcast from the Admin dashboard you will be redirected to the Podcast dashboard page.
The Podcast dashboard shows you up to five of the latest episodes, both those published and scheduled. You can click
on any of these episodes to view them or click `See all episodes` to see a list of every episode.
## Edit your podcast
To edit your podcast, press `Edit podcast` in the upper right hand corner or `Edit podcast` in the left hand side
navigation.
You can edit any of the [fields you filled out when creating your podcast](/docs/en/user-guide/instance/add-podcast).
When finished press the `Save podcast` button in the upper right hand corner.
You can also choose to delete your podcast by pressing `Delete podcast` at the bottom of the Edit podcast page.
## Manage persons
If you have added people to Persons in the Admin dashboard, you can assign them a role here. People assigned roles
will show up on the [Credits page](/docs/en/user-guide/website/credits) linked from your home page to give them
credit for contributing to the podcast.
Roles include Administration, Audio production, cast, guests, hosts, writing, and more.
From the **Persons** drop down, choose the person you want to add. Then choose a role from the \*_Roles_ drop down and
press `Add person(s)`.
A list of all people assigned roles will be displayed. You can remove them by pressing the `Remove` button.
Adding persons to your podcast populates the Credits page linked from your
[home page](/docs/en/user-guide/website/index.md).
## Podcast imports
Podcast imports show you the status of a feed that you imported into Castopod, including the feed name,
how long the import took, and how many episodes were imported. Under **Actions** you can try re-import the feed
if the original import failed or delete the status message for the imported feed.
If the feed you imported has been updated after your import, press `Synchronize Feeds` in the upper right hand
corner to import the missing episodes.
## Sync feeds
You can also synchronize missing episode from an imported feed by choosing `Sync Feeds` from the Podcast dashboard
menu. The **Feed URL** should auto-populate if you have previously imported a feed. Press `Add to queue` to import
any missing episodes from the feed.

131
docs/src/content/docs/en/user-guide/podcast/episodes.mdx Normal file
View File

@ -0,0 +1,131 @@
---
title: Episodes
---
From the left hand navigation, click **Episodes** and the menu will expand to **All Episodes** and **New Episode**.
## All Episodes
To view a list of all episodes, click `All Episodes`. Each episode will be displayed in a list with its name and
notes, Visibility such as published or scheduled, and how many downloads and comments each episode has.
### Actions and the Episode Dashboard
Click the three dots under **Actions** to view a menu of options for an episode or click on an individual episode to
view the available actions:
- **Go to page**: This will redirect you to the public page of the episode and display the show notes.
- **Edit**: This allows you to change the fields you filled when creating the episode (see below).
### Embeddable player
Choose a theme color and press the copy button to the right of the text box to copy the
code to your clipboard. Insert the code into a web page to display the episode.
### Persons
If you have added people in the Admin interface, you can choose a person and assign them a role, such
as guest, for a given episode.
### Video clips and Soundbites
The process to create a video clip and soundbite is the same. It may take a minute for the file to load and you
will see the waveform.
A video clip will create an MP4 video of the audio with text from the transcript matched to the audio. A soundbite
will create an audio clip.
Enter the name of the clip you want to create. Then drag the slider to where you want to start and end your
video clip or soundbite. You can press the `Play` button to preview your clip.
For video clips, choose a format, including Landscape, Portrait or Squared and a background theme color.
Then press the `Create` button, you will be redirected to a status page displaying the status of creating the clip.
Refresh the page to see if it's `Running` or completed. You may need to be patient depending on the length of the clip.
:::note
To create video clips and soundbites, your server must have `FFMPEG` installed and a transcript.
:::
## Create episode
To add an episode, press the `Add an episode button` in the upper right hand corner of the Episode dashboard or click
`New episode` in the left hand navigation under `Episodes`.
### Episode Info
#### Audio file
Press the `Choose File` button to select the audio file to upload to Castopod. The audio file must be an mp3 or m4a
file and cannot be larger than 512 megabytes.
### Episode cover
You can optionally add a different podcast cover / artwork. Press `Choose File` and select an image from your computer
that must be at least 1400px wide and tall and no larger than 3000px wide and tall. If you do not choose an
episode cover, your default podcast artwork will be used.
#### Title
Enter the name for your new episode. Do not add the season or episode number in the **Title** field. Choose a clear
and concise episode name to help your listeners.
#### Permalink
The permalink is the link to the public episode page. This will be automatically filled out based on the title
you entered above. If you wish to have a different permalink, press the edit button to the right of the
displayed permalink.
#### Season and Episode
You can optionally add a season and / or episode number to your episode. If you are adding a new episode and a
previous episode had a season and /or episode number, the field(s) will be auto filled for you. You can leave it or
update with a different season and / or episode number.
### Show Notes
Describe your episode in detail. You can use up to 4000 characters, and you can use Markdown to style your show
notes. You can expand the text box by pressing and holding the bottom right corner of the text box.
When your show notes are complete, press `Preview` to view how your show notes will be displayed.
### Additional Files
#### Transcripts
You can add a transcript to your episode by choosing a file in SRT or VTT format to upload. Transcripts will be
shown in a tab on the episode page and some podcast apps such as Apple Podcasts can display the transcript.
Transcripts help users who may have a hearing disability and can also help with search engine optimization.
#### Chapters
You can optionally upload a chapters file in JSON format. To learn more about chapters and for an example of the
correct format, visit the [Podcast Namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/chapters/jsonChapters.md).
:::note
Not all podcast players natively support chapters in JSON format. More modern players, such as Fountain and
Apple Podcasts, do support chapters in JSON format. Chapters do not allow you to click to select the chapter
in Castopod's embeddable player at this time.
:::
### Publish your episode
When complete, press the `Create episode` button at the bottom of the page. You will be automatically directed to
the next step to publish your episode. Your episode is in draft mode and is not yet published. You can preview
how your episode will look when published or publish your episode. To publish your episode, press the `Publish` button
in the upper right hand corner.
### Create your announcement post
After pressing `Publish` you will be directed to the next page to draft your announcement post. Write your message
in the text box provided. This will be the message broadcast to the Fediverse and published on your podcast's home
page.
### Publication date
Choose `Now` or `Schedule` to publish your episode. If you choose `Now`, your episode will be live. Or you can
schedule the day and time to publish your episode by choosing the `Schedule` radio button and choosing the day and
time. Press `Publish` to finish.
Your RSS feed will be automatically updated with your episode information and listeners who subscribe will be
notified of a new episode. Congratulations on publishing your first episode!

20
docs/src/content/docs/en/user-guide/podcast/index.mdx Normal file
View File

@ -0,0 +1,20 @@
---
title: Manage Podcasts
---
import { LinkCard, CardGrid } from "@astrojs/starlight/components";
From the Castopod admin interface, click **Podcasts** and then **All Podcasts** and you will be redirected to the
podcast dashboard. This page displays the latest episodes, including any scheduled episodes.
From the podcast dashboard, you can add episodes, view analytics, add links to your homepage, and more. Learn more
by clicking the links below.
<CardGrid>
<LinkCard title="Podcast dashboard" href="dashboard" />
<LinkCard title="Episodes" href="episodes" />
<LinkCard title="Analytics" href="analytics" />
<LinkCard title="Broadcast" href="broadcast" />
<LinkCard title="Monetization" href="monetization" />
<LinkCard title="Contributors" href="contributors" />
</CardGrid>

74
docs/src/content/docs/en/user-guide/website/index.mdx Normal file
View File

@ -0,0 +1,74 @@
---
title: Podcast Home Page
---
The podcast home page is your landing page for your listeners to view episode announcements, messages, episodes,
and links to where to find your podcast. If you have only one podcast, your users will be automatically redirected
from your top level domain, such as `www.yourpodcast.com`, to the podcast page at
`www.yourpodcast.com/yourpodcasthandle`.
If you are hosting multiple podcasts, your top level page will display the artwork for each podcast. Clicking on
the podcast artwork will take you to your podcast page at `www.yourpodcast.com/yourpodcasthandle`.
## Home Page
If you are logged in to your podcast, you will see a strip across the top of the page with a link to the admin
interface of your podcast, a bell that will show if you have any new notifications, and the user who is logged in.
You can click on the user for quick access to your account, changing your password, or to log out.
:::note
If you have multiple podcasts, you can click the user dropdown to switch to choose which podcast to interact with.
If your account has access to two or more podcasts, pay attention to which podcast is broadcasting messages!
:::
Listeners can click the `Follow` button to follow any messages, including episode announcements, from a Fediverse
app, such as Mastodon. After clicking `Follow` a pop-up box will be displayed where the user enterse their Fediverse
handle and then clicks `Proceed to follow`.
### Podcast RSS feed
On the right hand side is a link to your RSS Podcast feed. Users can copy that and subscribe directly in their
podcast app.
### Social Networks
Below the RSS feed is are icons that link to all of the social networks you toggled on in the
[Broadcast](/docs/en/user-guide/podcast/broadcast#podcasting-apps) section of the podcast's admin section.
### Podcast Directories
Below the social networking links is **Listen On** which displays icons linked to the podcast directories you
toggled on in the [Broadcast](/docs/en/user-guide/podcast/broadcast#social-networks) section of the podcast's
admin section.
## Activity
The **Activity** tab is located directly under your podcast artwork is the default home page for your podcast. Website
visitors are presented with a list of messages in chronological order. If you are logged in as a podcast
administrator, you will see a text box where you can write a message to be broadcasted to your followers. If you
include the episode URL, a preview of that episode will be included in your message.
Below each message there are four icons:
- **Comments**: This will show you the number of comments on a given message. Clicking this will show you all replies to
your message. You can click the three dots to block a user or a domain in case of spam.
- **Shares**: This shows the number of times your message was shared by other users.
- **Favorites**: This shows how many people liked your message.
## Episodes
The **Episodes** tab shows a list of all episode announcements you have shared. If you are using season numbers, it
will default to the current season. Users can click the **Season** link above all of the messages for a dropdown menu
to view past episodes by season.
## About
The About tab shares general information about your podcast, including:
- Podcast description
- Podcast category
- The [people](/docs/en/user-guide/podcast/podcast-dashboard#manage-persons/) who contribute to the podcast
- Statistics
- Number of seasons
- Number of episodes
- Date first episode was published