mirror of
https://github.com/PR0M3TH3AN/bitvid.git
synced 2026-11-06 04:42:57 +00:00
docs: align upload guides with code and add consistency test
- Updates `content/docs/guides/upload-content.md` and `getting-started.md` to accurately reflect supported file types, S3-compatible storage options, and metadata requirements. - Clarifies CORS configuration steps for R2 vs. generic S3. - Adds `tests/docs/verify-upload-claims.test.mjs` to programmatically ensure documentation claims match frontend code attributes. Co-authored-by: PR0M3TH3AN <[email protected]>
This commit is contained in:
1 parent
7ff26f7f69
commit
f6e48b3bd6
3 files changed
+131
-56
No files matched your search
@@ -6,8 +6,8 @@ Ready to jump in? Here's everything you need to know to start watching and shari
|
||||
2. **(Optional) Install as an App:**
|
||||
- **Desktop:** On Chrome-based browsers, click the "Install" icon in the address bar to run bitvid as a standalone app.
|
||||
- **Mobile:** Tap "Share" (iOS) or the menu (Android) and select "Add to Home Screen".
|
||||
3. Browse the videos on the homepage
|
||||
4. Click any video to start watching
|
||||
3. Browse the videos on the homepage.
|
||||
4. Click any video to start watching.
|
||||
That's it! No account needed to watch.
|
||||
|
||||
## Sharing Your Videos
|
||||
@@ -16,37 +16,36 @@ Ready to jump in? Here's everything you need to know to start watching and shari
|
||||
|
||||
> ⚠️ **Note:** We are currently invite-only. [Submit an application](https://bitvid.network/?modal=application) to request approval for posting content.
|
||||
|
||||
1. Install a [Nostr extension](https://nostrapps.com/#signers#all) (like Alby or Nos2x) in your browser
|
||||
2. The extension creates your secure login key automatically
|
||||
3. Click "Login" on bitvid to connect
|
||||
1. Install a [Nostr extension](https://nostrapps.com/#signers#all) (like Alby or Nos2x) in your browser.
|
||||
2. The extension creates your secure login key automatically.
|
||||
3. Click "Login" on bitvid to connect.
|
||||
|
||||
### Step 2: Prepare Your Video
|
||||
|
||||
1. Host your video at an HTTPS URL that browsers can stream directly. If you are uploading a file directly via bitvid, we accept **MP4, WebM, MOV, MKV, TS, M3U8, MPG, and MPEG** (Max 2GB recommended). For external hosting, ensure the format is streamable (MP4/WebM/HLS/DASH). You can use your own CDN, Cloudflare Stream, an R2 bucket, or any static site host—as long as the link begins with `https://`.
|
||||
2. (Optional but recommended) Generate a WebTorrent magnet so viewers can fall back to peer-to-peer delivery. Desktop apps like [WebTorrent Desktop](https://webtorrent.io/desktop/) or command-line tools can create the magnet for you.
|
||||
3. Double-check that either the hosted URL or the magnet (or both) is ready before you open the Upload modal.
|
||||
1. **Format:** We accept **.mp4, .webm, .mov, .mkv, .ts, .m3u8, .mpg, .mpeg** (Max 2GB recommended).
|
||||
2. **Hosting:** You can upload directly via bitvid (requires your own Cloudflare R2 or S3 bucket) or host your video elsewhere (CDN, Cloudflare Stream, etc.) and provide the HTTPS URL. For external hosting, ensure the format is streamable (MP4/WebM/HLS/DASH).
|
||||
3. **(Optional) WebTorrent:** If hosting externally, you can generate a WebTorrent magnet so viewers can fall back to peer-to-peer delivery.
|
||||
|
||||
### Step 3: Share on bitvid
|
||||
|
||||
1. Click "Share a Video" on bitvid to open the upload modal.
|
||||
2. Choose your upload mode:
|
||||
- **Upload Video**: Select a file from your device to upload directly to your Cloudflare R2 bucket. If you haven't configured storage yet, click **"Configure Storage"** to enter your R2 credentials (Account ID, Access Key ID, Secret Access Key, Bucket Name, Public Access URL) in your Profile settings.
|
||||
- **Upload Video**: Select a file from your device to upload directly to your Cloudflare R2 or S3-compatible bucket. If you haven't configured storage yet, click **"Configure Storage"** to enter your credentials (Account ID/Endpoint, Access Keys, Bucket Name, Public URL) in your Profile settings.
|
||||
- **External URL**: If you already host your video elsewhere, paste the HTTPS URL and (optionally) a WebTorrent magnet link.
|
||||
3. Review the rest of the form: add a description and thumbnail, decide whether to allow comments, and set the NSFW or "For Kids" toggles to match your content. Explore the metadata section to fill in captions, duration, publish time, hashtags, participants, and other fields so first-time viewers have all the context they need.
|
||||
3. Review the rest of the form: add a description and thumbnail, decide whether to allow comments, and set the NSFW or "For Kids" toggles to match your content. Explore the metadata section to fill in captions, duration, hashtags, and other fields.
|
||||
4. Click "Publish Video" to post your content.
|
||||
|
||||
## Tips for Success
|
||||
|
||||
- Keep WebTorrent Desktop running while sharing videos
|
||||
- Add eye-catching thumbnails to attract viewers
|
||||
- Write clear descriptions to help people find your content
|
||||
- After posting, open a card’s **More → Edit** action and use the [visibility toggle in the Edit Video modal](../components/edit-video-modal.html) to keep it private until you’re ready to share
|
||||
- Encrypted watch-history sync lives in the [Watch History view](history.html), where you can clear devices or pause tracking whenever you need.
|
||||
- **Thumbnails:** Add eye-catching thumbnails to attract viewers.
|
||||
- **Descriptions:** Write clear descriptions to help people find your content.
|
||||
- **Visibility:** After posting, you can use the **More → Edit** action to toggle visibility or delete content.
|
||||
- **Watch History:** Encrypted watch-history sync lives in the [Watch History view](history.html), where you can clear devices or pause tracking whenever you need.
|
||||
|
||||
## Need Help?
|
||||
|
||||
- Visit our [GitHub](https://github.com/PR0M3TH3AN/bitvid) page for technical support
|
||||
- Join our [community](https://primal.net/p/npub13yarr7j6vjqjjkahd63dmr27curypehx45ucue286ac7sft27y0srnpmpe) to connect with other users
|
||||
- Report bugs to help us improve
|
||||
- Visit our [GitHub](https://github.com/PR0M3TH3AN/bitvid) page for technical support.
|
||||
- Join our [community](https://primal.net/p/npub13yarr7j6vjqjjkahd63dmr27curypehx45ucue286ac7sft27y0srnpmpe) to connect with other users.
|
||||
- Report bugs to help us improve.
|
||||
|
||||
Welcome to bitvid – let's start sharing!
|
||||
Reference in new issue
Block a user