cobalt/README.md

89 lines
7.3 KiB
Markdown
Raw Normal View History

2022-07-08 19:17:56 +01:00
# cobalt
Best way to save what you love.
Main instance: [co.wukko.me](https://co.wukko.me/)
![cobalt logo with repeated logo pattern background](https://raw.githubusercontent.com/wukko/cobalt/current/src/front/icons/pattern.png "cobalt logo with repeated logo pattern background")
2022-09-04 06:37:09 +01:00
2022-09-04 06:36:45 +01:00
[![Crowdin](https://badges.crowdin.net/cobalt/localized.svg)](https://crowdin.com/project/cobalt) [![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=active+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge) [![DeepSource](https://deepsource.io/gh/wukko/cobalt.svg/?label=resolved+issues&token=MsmsJ9zUOKwcQor0yaiFot84)](https://deepsource.io/gh/wukko/cobalt/?ref=repository-badge)
2022-07-08 19:17:56 +01:00
## What's cobalt?
2023-03-24 17:41:58 +00:00
cobalt is a 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.
2022-07-08 19:17:56 +01:00
2022-09-03 16:34:23 +01:00
## Supported services
| Service | Video + Audio | Only audio | Only video | Additional notes or features |
| -------- | :---: | :---: | :---: | :----- |
| bilibili.com | [x] | [x] | [x] | |
| Instagram | [x] | [x] | [x] | Ability to pick what to save from multi-media posts. |
| Instagram Reels | [x] | [x] | [x] | |
| Reddit | [x] | [x] | [x] | Support for GIFs and videos. |
| SoundCloud | - | [x] | - | Audio metadata, downloads from private links. |
| TikTok | [x] | [x] | [x] | Supports downloads of: videos with or without watermark, images from slideshow without watermark, full (original) audios. |
| Tumblr | [x] | [x] | [x] | |
| Twitter | [x] | [x] | [x] | Ability to pick what to save from multi-media tweets. |
| Twitter Spaces | [x] | [x] | [x] | Audio metadata with all participants and other info. |
| Vimeo | [x] | [x] | [x] | Audio downloads are only available for dash files. |
| Vine Archive | [x] | [x] | [x] | |
| VK Videos | [x] | [ ] | [ ] | |
| VK Clips | [x] | [ ] | [ ] | |
| YouTube Videos & Shorts | [x] | [x] | [x] | Support for 8K, 4K, HDR, and high FPS videos. Audio metadata & dubs. h264/av1/vp9 codecs. |
| YouTube Music | - | [x] | - | Audio metadata. |
This list is not final and keeps expanding over time, make sure to check it once in a while!
2022-12-17 11:22:39 +00:00
## 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.
2022-09-03 16:32:39 +01:00
## How to contribute translations
2023-03-24 17:41:58 +00:00
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.
2022-09-03 16:32:39 +01:00
### Translation guidelines:
- Text is **ALWAYS** stylized as **lowercase** unless it's STRESSED LIKE THIS or is an internal value like `{ContactLink}` or `{appName}`.
2023-03-24 17:41:58 +00:00
- 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.
2023-03-24 17:41:58 +00:00
- 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.
## Host an instance yourself
2022-07-08 19:17:56 +01:00
### Requirements
- Node.js 18 or above
2022-07-08 19:17:56 +01:00
- git
Setup script installs all needed `npm` dependencies, but you have to install `Node.js` and `git` yourself.
2022-07-08 19:17:56 +01:00
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`
2022-07-08 19:17:56 +01:00
4. Done.
### 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
```
2023-04-09 03:49:51 +01:00
### 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` |
2023-04-09 03:49:51 +01:00
## 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.
2022-07-08 19:17:56 +01:00
## License
cobalt is under [AGPL-3.0](https://github.com/wukko/cobalt/blob/current/LICENSE) license.
2023-01-29 18:39:53 +00:00
[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.