52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
# Podcast Server
|
|
|
|
This is a really simple project allowing for quick creation of podcasts. The server provides a simple admin panel to manage podcasts, and the ability to upload episodes. Any uploaded episodes have their audio level normalised, and are re-encoded to AAC which tends to use less disk space than original formats.
|
|
|
|
### Environment Variables
|
|
|
|
| Name | Default | Description |
|
|
| ---- | ------- | ----------- |
|
|
| `PG_DIRECTORY` | `./data` (`/data` for Docker) | Where any files are stored. This includes episodes, images and application data. |
|
|
| `PG_UPLOADS_DIRECTORY` | `./uploads` (`/uploads` for Docker) | Where any currently uploading files are stored. This directory does not need persistence in Docker. |
|
|
| `PG_OIDC_AUTHORIZE_URL` _(required)_ | | The OpenID Connect authorize endpoint from the authentication provider. |
|
|
| `PG_OIDC_TOKEN_URL` _(required)_ | | The OpenID Connect token endpoint from the authentication provider. |
|
|
| `PG_OIDC_JWKS_URL` _(required)_ | | The OpenID Connect JWKS endpoint from the authentication provider. |
|
|
| `PG_OIDC_AUTHORITY` _(required)_ | | The OpenID Connect issuer URL from the authentication provider. |
|
|
| `PG_OIDC_PERMITTED_JWT_AUDIENCES` _(required)_ | | A list of valid audiences from the authentication provider. |
|
|
| `PG_OIDC_CLIENT_ID` _(required)_ | | The OpenID Connect client ID from the authentication provider. |
|
|
| `PG_OIDC_SUB_JWT_ATTRIBUTE` | `sub` | The JWT token attribute that contains the user's ID. |
|
|
| `PG_OIDC_NAME_JWT_ATTRIBUTE` | `name` | The JWT token attribute that contains the user's name or username. |
|
|
| `PG_OIDC_SCOPES` | `["openid", "email", "profile", "offline_access"]` | OpenID Connect scopes. |
|
|
|
|
## Development
|
|
|
|
### Backend
|
|
|
|
This backend of the project is made using Python and FastAPI. To get started, ensure you have [Python](https://www.python.org/) and the [uv](https://docs.astral.sh/uv/) package manager installed.
|
|
|
|
```bash
|
|
# install dependencies
|
|
uv sync
|
|
|
|
# migrate the database
|
|
uv run alembic upgrade head
|
|
|
|
# run server in development mode
|
|
uv run fastapi dev main.py
|
|
```
|
|
|
|
### Frontend
|
|
|
|
The frontend of the project is made using Solid.js. To get started, ensure you have [Node.js]() installed, and corepack enabled (with `corepack enable`).
|
|
|
|
```bash
|
|
cd frontend
|
|
|
|
# install dependencies
|
|
pnpm install
|
|
|
|
# run server in development mode
|
|
pnpm run dev
|
|
```
|
|
|
|
After changing the backend, run `pnpm run generate-client` to generate the API client for the frontend from the server's OpenAPI schema.
|