Merge branch 'current' into feat/twitch
This commit is contained in:
wukko
48
README.md
48
README.md
@@ -1,13 +1,13 @@
|
||||
# cobalt
|
||||
Best way to save what you love.
|
||||
Main instance: [co.wukko.me](https://co.wukko.me/)
|
||||
Live web app: [cobalt.tools](https://cobalt.tools/)
|
||||
|
||||
|
||||
|
||||
[](https://crowdin.com/project/cobalt) [](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) [](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge)
|
||||
[](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge)
|
||||
|
||||
## What's cobalt?
|
||||
cobalt is a social and media platform downloader that doesn't piss you off.
|
||||
cobalt is social and media platform downloader that doesn't piss you off.
|
||||
|
||||
It's fast, friendly, and doesn't have any bullshit that modern web is filled with: no ads, trackers, or analytics.
|
||||
Paste the link, get the video, move on. It's that simple. Just how it should be.
|
||||
@@ -16,40 +16,31 @@ Paste the link, get the video, move on. It's that simple. Just how it should be.
|
||||
| Service | Video + Audio | Only audio | Only video | Additional notes or features |
|
||||
| -------- | :---: | :---: | :---: | :----- |
|
||||
| bilibili.com | ✅ | ✅ | ✅ | |
|
||||
| Instagram | ✅ | ✅ | ✅ | Ability to pick what to save from multi-media posts. |
|
||||
| Instagram | ✅ | ✅ | ✅ | Supports photos and videos, lets you pick what to save from multi-media posts. |
|
||||
| Instagram Reels | ✅ | ✅ | ✅ | |
|
||||
| Pinterest | ✅ | ✅ | ✅ | Support for videos and stories. |
|
||||
| Reddit | ✅ | ✅ | ✅ | Support for GIFs and videos. |
|
||||
| SoundCloud | ➖ | ✅ | ➖ | Audio metadata, downloads from private links. |
|
||||
| Streamable | ✅ | ✅ | ✅ | |
|
||||
| TikTok | ✅ | ✅ | ✅ | Supports downloads of: videos with or without watermark, images from slideshow without watermark, full (original) audios. |
|
||||
| Tumblr | ✅ | ✅ | ✅ | |
|
||||
| Twitter | ✅ | ✅ | ✅ | Ability to pick what to save from multi-media tweets. |
|
||||
| Twitter Spaces | ➖ | ✅ | ➖ | Audio metadata with all participants and other info. |
|
||||
| Twitch | ✅ | ✅ | ✅ | |
|
||||
| Tumblr | ✅ | ✅ | ✅ | Support for audio file downloads. |
|
||||
| Twitch Clips/VODs | ✅ | ✅ | ✅ | |
|
||||
| Twitter/X * | ✅ | ✅ | ✅ | Ability to pick what to save from multi-media tweets. |
|
||||
| Vimeo | ✅ | ✅ | ✅ | Audio downloads are only available for dash files. |
|
||||
| Vine Archive | ✅ | ✅ | ✅ | |
|
||||
| VK Videos | ✅ | ❌ | ❌ | |
|
||||
| VK Clips | ✅ | ❌ | ❌ | |
|
||||
| YouTube Videos & Shorts | ✅ | ✅ | ✅ | Support for 8K, 4K, HDR, and high FPS videos. Audio metadata & dubs. h264/av1/vp9 codecs. |
|
||||
| YouTube Videos & Shorts | ✅ | ✅ | ✅ | Support for 8K, 4K, HDR, VR, and high FPS videos. Audio metadata & dubs. h264/av1/vp9 codecs. |
|
||||
| YouTube Music | ➖ | ✅ | ➖ | Audio metadata. |
|
||||
|
||||
This list is not final and keeps expanding over time, make sure to check it once in a while!
|
||||
|
||||
*Reliability of downloads from Twitter is questionable due to its current management.
|
||||
|
||||
## cobalt API
|
||||
cobalt has an open API that you can use in your projects for **free**.
|
||||
It's easy and straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/API.md) and see for yourself.
|
||||
|
||||
## How to contribute translations
|
||||
You can translate cobalt to any language you want on [cobalt's Crowdin](https://crowdin-co.wukko.me/). Feel free to ignore QA errors if you think you know better. If you don't see a language you want to translate cobalt to, open an issue, and I'll add it to Crowdin.
|
||||
|
||||
### Translation guidelines:
|
||||
- Text is **ALWAYS** stylized as **lowercase** unless it's STRESSED LIKE THIS or is an internal value like `{ContactLink}` or `{appName}`.
|
||||
- Example: "`this is a live video, i am yet to learn how to look into future. wait for the stream to finish and try again!`".
|
||||
*Notice how **everything is lowercase**, no matter the punctuation marks? Yes, that's cobalt's style and you have to follow it.*
|
||||
- Avoid extremely formal language, leave it for big and classy tech companies. Use informal language wherever possible.
|
||||
- You can (and should) rephrase sentences as long as they keep the same sense and send the same message as original.
|
||||
- Do **NOT** use offensive or explicit vocabulary.
|
||||
- Check if there are issues in UI with your localization and optimize it accordingly. If impossible, open an issue.
|
||||
- Be nice.
|
||||
It's easy and straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/API.md) and see for yourself.
|
||||
Feel free to use the main API instance ([co.wuk.sh](https://co.wuk.sh/)) in your projects.
|
||||
|
||||
## Host an instance yourself
|
||||
### Requirements
|
||||
@@ -63,6 +54,8 @@ Setup script installs all needed `npm` dependencies, but you have to install `No
|
||||
3. Run cobalt via `npm start`
|
||||
4. Done.
|
||||
|
||||
You need to host API and web app separately since v.6.0. Setup script will help you with that!
|
||||
|
||||
### Ubuntu 22.04+ workaround
|
||||
`nscd` needs to be installed and running so that the `ffmpeg-static` binary can resolve DNS ([#101](https://github.com/wukko/cobalt/issues/101#issuecomment-1494822258)):
|
||||
|
||||
@@ -72,13 +65,8 @@ sudo service nscd start
|
||||
```
|
||||
|
||||
### Docker
|
||||
It's also possible to run cobalt via Docker, but you **need** to set all environment variables yourself:
|
||||
|
||||
| Variable | Description | Example |
|
||||
| -------- | :--- | :--- |
|
||||
| `selfURL` | Instance URL | `http://localhost:9000/` or `https://co.wukko.me/` or etc |
|
||||
| `port` | Instance port | `9000` |
|
||||
| `cors` | CORS toggle | `0` |
|
||||
It's also possible to run cobalt via Docker. I *highly* recommend using Docker compose.
|
||||
Check out the [example compose file](https://github.com/wukko/cobalt/blob/current/docker-compose.example.yml) and alter it for your needs.
|
||||
|
||||
## Disclaimer
|
||||
cobalt is my passion project, so update schedule depends solely on my free time, motivation, and mood.
|
||||
|
||||
Reference in New Issue
Block a user