diff --git a/README.md b/README.md index 518e89e8..d336f09d 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,11 @@ # cobalt -best way to save what you love: [cobalt.tools](https://cobalt.tools/) +best way to save what you love: [cobalt.tools](https://cobalt.tools/) -![cobalt logo with repeated logo (double arrow) pattern background](/src/front/icons/pattern.png "cobalt logo with repeated logo (double arrow) pattern background") - -[💬 community discord server](https://discord.gg/pQPt8HBUPu) -[🐦 twitter/x](https://x.com/justusecobalt) +[💬 community discord server](https://discord.gg/pQPt8HBUPu) +[🐦 twitter/x](https://x.com/justusecobalt) ## 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 invasive analytics***. +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 invasive analytics***. paste the link, get the file, move on. it's that simple. just how it should be. @@ -58,20 +56,8 @@ this list is not final and keeps expanding over time. if support for a service y | 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. | -## 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](/docs/api.md) to learn how to use it. - -✅ you can use the main api instance ([api.cobalt.tools](https://api.cobalt.tools/)) in your **personal** projects. -❌ you cannot use the free api commercially (anywhere that's gated behind paywalls or ads). host your own instance for this. - -we reserve the right to restrict abusive/excessive access to the main instance api. - -## how to run your own instance -if you want to run your own instance for whatever purpose, [follow this guide](/docs/run-an-instance.md). -it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes. - -## partners -cobalt is sponsored by [royalehosting.net](https://royalehosting.net/?partner=cobalt), all main instances are currently hosted on their network :) +## partners +cobalt is sponsored by [royalehosting.net](https://royalehosting.net/?partner=cobalt), 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. @@ -79,25 +65,7 @@ cobalt is a tool for easing content downloads from internet and takes ***zero li 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 license -cobalt api code is licensed under [AGPL-3.0](/LICENSE). cobalt web code is licensed under [CC-BY-NC-SA-4.0](/web/LICENSE). - -cobalt branding, mascots, and other related assets included in the repo are ***copyrighted*** and not covered by the license. you ***cannot*** use them under same terms. - -you are allowed to host an ***unmodified*** instance of cobalt with branding, but this ***does not*** give you permission to use it anywhere else, or make derivatives of it in any way. - -### notes: -- mascots and other assets are a part of the branding. - -- when making an alternative version of the project, please replace or remove all branding (including the name). - -- you **must** link the original repo when using any parts of code (such as using separate processing modules in your project) or forking the project. - -- if you make a modified version of cobalt, the codebase **must** be published under the same license (according to AGPL-3.0). - -## 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/). +for relevant licensing information, see the [api](api/README.md) and [web](web/README.md) READMEs. ## acknowledgements ### ffmpeg @@ -111,7 +79,7 @@ we use [ffmpeg-static](https://github.com/eugeneware/ffmpeg-static) to get binar you can support the developer via various methods listed on their github page! (linked above) ### youtube.js -cobalt relies on [youtube.js](https://github.com/LuanRT/YouTube.js) for interacting with the innertube api, it wouldn't have been possible without it. +cobalt relies on [youtube.js](https://github.com/LuanRT/YouTube.js) for interacting with the innertube api, it wouldn't have been possible without it. you can support the developer via various methods listed on their github page! (linked above) diff --git a/api/README.md b/api/README.md new file mode 100644 index 00000000..2d430dc9 --- /dev/null +++ b/api/README.md @@ -0,0 +1,23 @@ +# cobalt api +[documentation] | [running your own instance](/docs/run-an-instance.md) + +## license +cobalt api code is licensed under [AGPL-3.0](LICENSE). + +this license allows you to modify, distribute and use the code for any purpose +as long as you: +- give appropriate credit to the original repo when using or modifying any parts of the code, +- provide a link to the license and indicate if changes to the code were made, and +- release the code under the **same license** + +## running your own instance +if you want to run your own instance for whatever purpose, [follow this guide](/docs/run-an-instance.md). +it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes. + +## accessing the api +currently, there is no publicly accessible main api. we plan on providing a public api for +cobalt 10 in some form in the future. we recommend deploying your own instance if you wish +to use the latest api. you can access [the documentation](/docs/api.md) for it here. + +if you are looking for documentations for version 7.x api, you can find +it [here](https://github.com/imputnet/cobalt/blob/7/docs/api.md) \ No newline at end of file diff --git a/docs/run-an-instance.md b/docs/run-an-instance.md index d31a67f5..8e3afd48 100644 --- a/docs/run-an-instance.md +++ b/docs/run-an-instance.md @@ -6,20 +6,20 @@ if you need help with installing docker, follow *only the first step* of these t - [how to install docker](https://www.digitalocean.com/community/tutorial-collections/how-to-install-and-use-docker) - [how to install docker compose](https://www.digitalocean.com/community/tutorial-collections/how-to-install-docker-compose) -## how to run a cobalt docker package: -1. create a folder for cobalt config file, something like this: +## how to run a cobalt docker package: +1. create a folder for cobalt config file, something like this: ```sh mkdir cobalt - ``` + ``` -2. go to cobalt folder, and create a docker compose config file: +2. go to cobalt folder, and create a docker compose config file: ```sh cd cobalt && nano docker-compose.yml - ``` - i'm using `nano` in this example, it may not be available in your distro. you can use any other text editor. + ``` + i'm using `nano` in this example, it may not be available in your distro. you can use any other text editor. -3. copy and paste the [sample config from here](examples/docker-compose.example.yml) for either web or api instance (or both, if you wish) and edit it to your needs. - make sure to replace default URLs with your own or cobalt won't work correctly. +3. copy and paste the [sample config from here](examples/docker-compose.example.yml) for either web or api instance (or both, if you wish) and edit it to your needs. + make sure to replace default URLs with your own or cobalt won't work correctly. 4. finally, start the cobalt container (from cobalt directory): ```sh @@ -72,16 +72,4 @@ sudo service nscd start setting a `FREEBIND_CIDR` allows cobalt to pick a random IP for every download and use it for all requests it makes for that particular download. to use freebind in cobalt, you need to follow its [setup instructions](https://github.com/imputnet/freebind.js?tab=readme-ov-file#setup) first. if you configure this option while running cobalt in a docker container, you also need to set the `API_LISTEN_ADDRESS` env to `127.0.0.1`, and set -`network_mode` for the container to `host`. - -### variables for web -| variable name | default | example | description | -|:---------------------|:----------------------------|:----------------------------|:--------------------------------------------------------------------------------------| -| `WEB_PORT` | `9001` | `9001` | changes port from which frontend server is accessible. | -| `WEB_URL` | ➖ | `https://cobalt.tools/` | changes url from which frontend server is accessible.
***REQUIRED TO RUN WEB***. | -| `API_URL` | `https://api.cobalt.tools/` | `https://api.cobalt.tools/` | changes url which is used for api requests by frontend clients. | -| `SHOW_SPONSORS` | `0` | `1` | toggles sponsor list in about popup.
`0`: disabled. `1`: enabled. | -| `IS_BETA` | `0` | `1` | toggles beta tag next to cobalt logo.
`0`: disabled. `1`: enabled. | -| `PLAUSIBLE_HOSTNAME` | ➖ | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. | - -\* don't use plausible.io as receiver backend unless you paid for their cloud service. use your own domain when hosting community edition of plausible. refer to their [docs](https://plausible.io/docs) when needed. +`network_mode` for the container to `host`. \ No newline at end of file diff --git a/web/README.md b/web/README.md index 930f5029..1b959731 100644 --- a/web/README.md +++ b/web/README.md @@ -1,2 +1,45 @@ # cobalt web -wip +the cobalt frontend is a static web app built with +[sveltekit](https://kit.svelte.dev/) + [vite](https://vitejs.dev/). + +## configuring +- to run a dev environment, run `pnpm run dev`. +- to make a release build of the frontend, run `pnpm run build`. + +## environment variables +the frontend has several build-time environment variables for configuring various features. to use +them, you must specify them when building the frontend (or running a vite server for development). + +| name | example | description | +|:---------------------|:----------------------------|:---------------------------------------------------------------------------------------------------------| +| `WEB_HOST` | `cobalt.tools` | domain on which the frontend will be running. used for meta tags and configuring plausible. | +| `WEB_PLAUSIBLE_HOST` | `plausible.io`* | enables plausible analytics with provided hostname as receiver backend. | +| `WEB_DEFAULT_API` | `https://api.cobalt.tools/` | changes url which is used for api requests by frontend clients. | +| `WEB_TURNSTILE_KEY` | `1x00000000000000000000AA` | [cloudflare turnstile](https://www.cloudflare.com/products/turnstile/) public key for antibot protection | + +\* don't use plausible.io as receiver backend unless you paid for their cloud service. + use your own domain when hosting community edition of plausible. refer to their [docs](https://plausible.io/docs) when needed. + +## license +cobalt web code is licensed under [CC-BY-NC-SA-4.0](LICENSE). + +this license allows you to: +- copy and redistribute the code in any medium or format, and +- remix, transform, use and build upon the code + +as long as you: +- give appropriate credit to the original repo, +- provide a link to the license and indicate if changes to the code were made, +- release the code under the **same license**, and +- **don't use the code for any commercial purposes**. + +cobalt branding, mascots, and other related assets included in the repo are ***copyrighted*** and not covered by the license. you ***cannot*** use them under same terms. + +you are allowed to host an ***unmodified*** instance of cobalt with branding for **non-commercial purposes**, but this ***does not*** give you permission to use it anywhere else, or make derivatives of it in any way. + +when making an alternative version of the project, please replace or remove all branding (including the name). + +## 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/).