-
Notifications
You must be signed in to change notification settings - Fork 0
Getting started
This guide walks you through first-time setup, creating your admin account, and making your first podcast and episode.
When you start a new HarborFM instance (Docker, Terraform, or local), the server prints a one-time setup URL to the console. You must open this URL in your browser to initialize the server.
Example from the logs:
Open this URL to initialize the server (runs once):
/setup?id=oFwK--nBt8YloIVABKA4nOmYy_Kbx7PS
-
Docker: Run
docker logs harborfm(or your container name) and look for this message. -
Local: Check the terminal where you ran
pnpm run devor the server process. - Terraform: After the VM boots, the setup URL may appear in user-data logs or you may need to open your domain and check the server response; the main README describes where to find it. You have the option of pre-configuring the setup and admin information using Terraform.
Open the full URL in your browser (e.g. https://your-domain.com/setup?id=...). If you lose the URL, restart the server to see it again; the token is regenerated only if the secrets file is missing.
On the setup page you will:
- Enter the admin email and password for the first (admin) account.
- Choose whether to allow account registration (so others can sign up).
- Choose whether to enable public feeds (so podcast and episode pages are visible to listeners).
Click through to complete setup. This step runs only once per instance.
After setup, sign in with the email and password you just set. You’ll land on the dashboard, which lists your podcast shows (empty at first).
- From the dashboard, create a new podcast (e.g. “New podcast” or similar button).
- Give it a name and any details you want.
- Open the show to configure artwork, description, and other settings. See Creating a show and Show settings and artwork.
- Open your show and go to the Episodes section.
- Create a new episode (e.g. “New episode”).
- Open the episode to enter the episode editor, where you build the episode from segments.
See Creating episodes and Episode editor overview.
In the episode editor you can:
- Record a new segment (in-browser recording).
- Upload an existing audio file as a segment.
- Insert from library - add intros, outros, or bumpers you’ve uploaded to your library.
Reorder segments, trim or split them, remove silence, and when ready click Make Final Episode to generate the final audio file. See Segments for details.
- Podcasts - Configure your show, collaborators, and permissions.
- Episodes - Manage episodes and the editor.
- Segments - Recording, library inserts, trimming, transcripts, and making the final episode.
- Library - Upload and manage reusable audio.
- Export and delivery - Deploy your RSS and audio to S3, FTP, or other targets.
For installation and server configuration, see the main README and Deployment.