updated docs
This commit is contained in:
wukko
137
README.md
137
README.md
@@ -1,78 +1,81 @@
|
||||
# cobalt
|
||||
Best way to save what you love.
|
||||
Live web app: [cobalt.tools](https://cobalt.tools/)
|
||||
best way to save what you love: [cobalt.tools](https://cobalt.tools/)
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge)
|
||||
## what's cobalt?
|
||||
cobalt is a media 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***.
|
||||
|
||||
## What's cobalt?
|
||||
cobalt is social and media platform downloader that doesn't piss you off.
|
||||
paste the link, get the file, move on. it's that simple. just how it should be.
|
||||
|
||||
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.
|
||||
## supported services
|
||||
this list is not final and keeps expanding over time. if support for a service you want is missing, create an issue (or a pull request 👀).
|
||||
|
||||
## Supported services
|
||||
| Service | Video + Audio | Only audio | Only video | Additional notes or features |
|
||||
| -------- | :---: | :---: | :---: | :----- |
|
||||
| bilibili.com | ✅ | ✅ | ✅ | |
|
||||
| Instagram | ✅ | ✅ | ✅ | Supports photos, videos, and stories. Lets you pick what to save from multi-media posts. |
|
||||
| Instagram Reels | ✅ | ✅ | ✅ | |
|
||||
| Pinterest | ✅ | ✅ | ✅ | Support for videos and stories. |
|
||||
| Reddit | ✅ | ✅ | ✅ | Support for GIFs and videos. |
|
||||
| Rutube | ✅ | ✅ | ✅ | |
|
||||
| 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 | ✅ | ✅ | ✅ | Support for audio file downloads. |
|
||||
| Twitch Clips | ✅ | ✅ | ✅ | |
|
||||
| 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, VR, and high FPS videos. Audio metadata & dubs. h264/av1/vp9 codecs. |
|
||||
| YouTube Music | ➖ | ✅ | ➖ | Audio metadata. |
|
||||
| service | video + audio | only audio | only video | metadata | rich file names |
|
||||
| -------- | :-----------: | :--------: | :--------: | :------: | :-------------: |
|
||||
| bilibili.com | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| instagram posts & stories | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| instagram reels | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| pinterest | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| reddit | ✅ | ✅ | ✅ | ❌ | ❌ |
|
||||
| rutube | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| soundcloud | ➖ | ✅ | ➖ | ✅ | ✅ |
|
||||
| streamable | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| tiktok | ✅ | ✅ | ✅ | ❌ | ❌ |
|
||||
| tumblr | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| twitch clips | ✅ | ✅ | ✅ | ✅ | ❌ |
|
||||
| twitter/x | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| vimeo | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| vine archive | ✅ | ✅ | ✅ | ➖ | ➖ |
|
||||
| vk videos & clips | ✅ | ❌ | ❌ | ✅ | ✅ |
|
||||
| youtube videos, shorts & music | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
|
||||
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.
|
||||
Feel free to use the main API instance ([co.wuk.sh](https://co.wuk.sh/)) in your projects.
|
||||
|
||||
## Host an instance yourself
|
||||
### Requirements
|
||||
- Node.js 18 or above
|
||||
- git
|
||||
|
||||
Setup script installs all needed `npm` dependencies, but you have to install `Node.js` and `git` yourself.
|
||||
|
||||
1. Clone the repo: `git clone https://github.com/wukko/cobalt`
|
||||
2. Run setup script and follow instructions: `npm run setup`
|
||||
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)):
|
||||
|
||||
```bash
|
||||
sudo apt install nscd
|
||||
sudo service nscd start
|
||||
```
|
||||
✅ : supported
|
||||
➖ : impossible/unreasonable
|
||||
❌ : not supported
|
||||
```
|
||||
|
||||
### Docker
|
||||
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.
|
||||
Don't expect any consistency in that.
|
||||
### additional notes or features (per service)
|
||||
| service | notes or features |
|
||||
| -------- | :----- |
|
||||
| instagram | supports photos, videos, and stories. lets you pick what to save from multi-media posts. |
|
||||
| pinterest | supports videos and stories. |
|
||||
| reddit | supports gifs and videos. |
|
||||
| soundcloud | supports private links. |
|
||||
| tiktok | supports videos with or without watermark, images from slideshow without watermark, and full (original) audios. |
|
||||
| twitter/x | lets you pick what to save from multi-media posts. may not be 100% reliable due to current management. |
|
||||
| vimeo | audio downloads are only available for dash. |
|
||||
| youtube | supports videos, music, and shorts. 8K, 4K, HDR, VR, and high FPS videos. rich metadata & dubs. h264/av1/vp9 codecs. |
|
||||
|
||||
## License
|
||||
cobalt is under [AGPL-3.0](https://github.com/wukko/cobalt/blob/current/LICENSE) license.
|
||||
[Fluent Emoji](https://github.com/microsoft/fluentui-emoji) used in the project is under [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.
|
||||
## cobalt api
|
||||
cobalt has an open api that you can use in projects *for completely free~*. it's easy and straightforward to use, [check out the docs](https://github.com/wukko/cobalt/blob/current/docs/api.md) to learn how to use it.
|
||||
|
||||
you can use the main api instance ([co.wuk.sh](https://co.wuk.sh/)) in your projects.
|
||||
|
||||
## how to run your own instance
|
||||
if you want to run your own instance for whatever purpose, [follow this guide](https://github.com/wukko/cobalt/blob/current/docs/run-an-instance.md).
|
||||
it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes.
|
||||
|
||||
## sponsors
|
||||
cobalt is sponsored by [royalehosting.net](https://royalehosting.net/), all main instances are currently hosted on their network :)
|
||||
|
||||
## ethics and disclaimer
|
||||
cobalt is a tool for easing content downloads from internet and takes ***zero liability***. you are responsible for what you download, how you use and distribute that content. please be mindful when using content of others and always credit original creators. fair use and credits benefit everyone.
|
||||
|
||||
cobalt is ***NOT*** a piracy tool and cannot be used as such. it can only download free, publicly accessible content. such content can be easily downloaded through any browser's dev tools. pressing one button is easier, so i made a convenient, ad-less tool for such repeated actions.
|
||||
|
||||
cobalt is my passion project, update schedule depends solely on my free time, motivation, and mood. don't expect any consistency in update releases.
|
||||
|
||||
## cobalt licenses
|
||||
cobalt code is licensed under [AGPL-3.0](https://github.com/wukko/cobalt/blob/current/LICENSE).
|
||||
|
||||
update banners and various assets of cobalt branding included within the repo are *not* covered by the AGPL-3.0 license and cannot be used using same terms.
|
||||
|
||||
## 3rd party licenses
|
||||
[Fluent Emoji by Microsoft](https://github.com/microsoft/fluentui-emoji) (used in cobalt) is under [MIT](https://github.com/microsoft/fluentui-emoji/blob/main/LICENSE) license.
|
||||
|
||||
[Noto Sans Mono](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/) fonts (used in cobalt) are licensed under the [OFL](https://fonts.google.com/noto/specimen/Noto+Sans+Mono/about) license.
|
||||
|
||||
many update banners were taken from [tenor.com](https://tenor.com/).
|
||||
Reference in New Issue
Block a user