cobalt/README.md

58 lines
2.2 KiB
Markdown
Raw Normal View History

<div align="center">
<br/>
<p>
<img src="web/static/favicon.png" title="cobalt" alt="cobalt logo" width="100" />
</p>
<p>
best way to save what you love
<br/>
<a href="https://cobalt.tools">
cobalt.tools
</a>
</p>
<p>
<a href="https://discord.gg/pQPt8HBUPu">
💬 community discord server
</a>
<a href="https://x.com/justusecobalt">
2024-10-20 12:45:10 +01:00
🐦 twitter
</a>
</p>
<br/>
</div>
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
cobalt is a media downloader that doesn't piss you off. it's friendly, efficient, and doesn't have ads, trackers, paywalls or other nonsense.
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
paste the link, get the file, move on. that simple, just how it should be.
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
### cobalt monorepo
this monorepo includes source code for api, frontend, and related packages:
- [api tree](/api/)
- [web tree](/web/)
- [packages tree](/packages/)
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
it also includes documentation in the [docs tree](/docs/):
- [cobalt api documentation](/docs/api.md)
2024-10-20 12:45:10 +01:00
- [how to run a cobalt instance](/docs/run-an-instance.md)
- [how to protect a cobalt instance](/docs/protect-an-instance.md)
- [how to configure a cobalt instance for youtube](/docs/configure-for-youtube.md)
2023-10-28 13:51:20 +01:00
### partners
2024-10-20 12:45:10 +01:00
cobalt is sponsored by [royalehosting.net](https://royalehosting.net/?partner=cobalt) and the main processing instance is hosted on their network. we really appreciate their kindness!
### ethics
cobalt is a tool that makes downloading public content easier. it takes **zero liability**.
the end user is responsible for what they download, how they use and distribute that content.
cobalt never caches any content, it [works like a fancy proxy](/api/src/stream/).
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
cobalt is in no way a piracy tool and cannot be used as such.
it can only download free & publicly accessible content.
same content can be downloaded via dev tools of any modern web browser.
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
### contributing
thank you for considering making a contribution to cobalt! please check the [contributing guidelines here](/CONTRIBUTING.md) before making a pull request.
2023-10-28 13:51:20 +01:00
2024-10-20 12:45:10 +01:00
### licenses
for relevant licensing information, see the [api](api/README.md) and [web](web/README.md) READMEs.
2024-09-09 17:00:23 +01:00
unless specified otherwise, the remainder of this repository is licensed under [AGPL-3.0](LICENSE).