https://github.com/cloudcloud/episodical
Self-hosted self-contained tracker of episodes, artists, and authors
https://github.com/cloudcloud/episodical
Last synced: 5 months ago
JSON representation
Self-hosted self-contained tracker of episodes, artists, and authors
- Host: GitHub
- URL: https://github.com/cloudcloud/episodical
- Owner: cloudcloud
- License: apache-2.0
- Created: 2024-07-04T11:34:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-10-28T21:55:27.000Z (8 months ago)
- Last Synced: 2025-10-28T23:28:42.800Z (8 months ago)
- Language: Elixir
- Size: 20.1 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Episodical
A self-contained full web application to manage and track Episodical, Artistic, and Document based entities.
## Usage
There are 4 configuration requirements for Episodical, provided via environment variables.
- `HOSTNAME` defines the hostname the service is made available under.
- `PORT` is the local port that Episodical will listen on for requests.
- `DATA_FILE` contains the full path filename of where the _sqlite3_ database will be stored.
- `DATA_PASSPHRASE` is the private phrase used to encrypt the _sqlite3_ content.
The provided `docker-compose.yml` file can be used to bring up the service (with the predefined defaults of the above configuration), to run the docker containerised version.
Releases of the binary can also be found on the releases page for the specific version requested (and the operating system + architecture combination).
## Integrations
There are several integrations available to utilise within Episodical to bring additional metadata for the different Episodical data types. Each of these integrations have their own configurations, which are each able to be configured from within the UI once Episodical is running. The configuration data for these is then stored within the encrypted _sqlite3_ database.
## Building
To build from source, `make install` will do everything that's necessary.
For a relatively quick development cycle, the following command works well:
```bash
make clean install && HOSTNAME=localhost PORT=8088 DATA_FILE=/var/episodical/episodical.db DATA_PASSPHRASE=no ./episodical
```
## Generating keys
```elixir
:crypto.strong_rand_bytes(32) |> :base64.encode
```