Tobi
d59968bb6b
Create OpenAPI specification schema
...
feat: Create OpenAPI Specification schema
- Adds a structured OpenAPI 3.0 specification for the Cobalt API.
- Provides a unified, standardized definition of endpoints, authentication, and request/response schemas.
- Enables easy generation of server and client SDKs with OpenAPI tools.
- Ensures better compliance with API documentation best practices.
- Improves maintainability and facilitates integrations with third-party services.
2025-02-16 15:32:30 +00:00
jj
33ce314775
docs/run-an-instance: remove mention of "web" in composefile
...
this has not been relevant for a while now
2025-02-11 20:14:31 +01:00
wukko
73f458a999
docs/api: update tiktokH265 description
2025-01-20 20:01:55 +06:00
hyperdefined
160160704d
docs/run-an-instance: add missing DISABLED_SERVICES
( #882 )
2024-11-03 17:29:42 +01:00
jj
40d6a02b61
api: cluster support
...
still missing synchronization for some structures
2024-10-31 22:59:06 +00:00
jj
5e92b649a3
api: add API_REDIS_URL
env
2024-10-30 18:59:20 +00:00
wukko
9cc2df9efd
docs/docker-compose: revamp the template, add read_only
...
we use `read_only` on the main instance and i think everyone else should use it too
2024-11-01 19:48:12 +06:00
wukko
c3a2386086
docs/api: add one more example of language codes for youtubeDubLang
2024-10-30 17:53:10 +06:00
wukko
486555bd11
docs/api: add youtubeHLS
and remove youtubeDubBrowserLang
2024-10-28 19:57:37 +06:00
jj
1b9855206e
docs/configure-for-youtube: omit run
from pnpm command
2024-10-20 23:12:35 +02:00
jj
429b7c85aa
docs/configure-for-youtube: change pnpm command
2024-10-20 23:12:07 +02:00
wukko
4b1ea6ed80
docs/protect-an-instance: update the template secret to fail
2024-10-20 20:18:50 +06:00
wukko
43b3139b4a
docs/protect-an-instance: skip second step of api keys config if remote
2024-10-20 19:53:17 +06:00
wukko
9790179e29
docs/protect-an-instance: add api keys configuration
2024-10-20 19:51:35 +06:00
wukko
a81a19de68
docs/protect-an-instance: add a command for generating a secret
2024-10-20 19:26:19 +06:00
wukko
155322a47b
docs/configure-for-youtube: clarify where to put the token
2024-10-20 18:59:07 +06:00
wukko
f33cf12fd3
docs/run-an-instance: update headings
2024-10-20 18:56:37 +06:00
wukko
6933daf046
docs: add configure-for-youtube document
2024-10-20 18:56:23 +06:00
wukko
a58684f314
docs/protect-an-instance: update the tuto value warning
2024-10-20 18:05:50 +06:00
wukko
722223f6d3
docs/protect-an-instance: fix image alignment
2024-10-20 18:02:24 +06:00
wukko
b837f291b5
docs/protect-an-instance: fix image sizes, add a secret warning
2024-10-20 17:59:38 +06:00
wukko
c494850cff
repo: update readme & remove old docs
2024-10-20 17:45:10 +06:00
wukko
67ffcdc504
docs/api: update the general api warning
2024-10-20 16:52:59 +06:00
wukko
7515204bb7
docs/api: update warnings
2024-10-20 16:51:38 +06:00
wukko
5ce3a941f9
docs/protect-an-instance: emphasize a warning in env variable section
2024-10-20 16:31:55 +06:00
wukko
90114bdbea
docs/protect-an-instance: update the note to show up as such
2024-10-20 16:28:22 +06:00
wukko
1cf82e4d69
docs: add a tutorial document for protecting an instance
2024-10-20 16:23:09 +06:00
dumbmoron
6cc895c395
docs/api: document /session
endpoint
2024-10-12 12:36:48 +00:00
dumbmoron
52c24ab1a3
docs/run-an-instance: add undocumented turnstile envs
2024-10-12 12:36:48 +00:00
dumbmoron
1c9685922f
docs/api: add information about auth header
2024-10-12 12:36:48 +00:00
dumbmoron
9f4f03ec6c
docs/examples/cookies: add youtube_oauth to examples
2024-10-12 11:06:19 +00:00
dumbmoron
3691e2e4f1
docs/run-an-instance: mention unlimited api keys
2024-10-04 17:43:35 +00:00
dumbmoron
741dfd40f5
api/security: implement api keys as method of authentication
2024-10-04 14:58:56 +00:00
lath
c2d7e1df12
api/config: add configuration for streamLifespan ( #792 )
2024-10-03 12:27:28 +06:00
wukko
9c2babfc1b
docs/run-an-instance: teaching myself how to count to 6
...
sorry guys, it takes a ton of practice :(
2024-09-13 12:39:10 +06:00
wukko
f830a1219d
docs/run-an-instance: update tutorial for running the api locally
2024-09-13 12:35:58 +06:00
dumbmoron
2dc9d64092
docs/examples: update composefile example
2024-09-09 16:50:50 +00:00
dumbmoron
a86a96d8ce
docs/api: also link to old docs for now
2024-09-09 15:50:51 +00:00
dumbmoron
7b06a5047f
repo: split README into subproject READMEs
2024-09-09 15:44:37 +00:00
dumbmoron
08490c54e4
api: include generated filename
in api response
2024-09-07 12:26:43 +00:00
wukko
fff1c6c7a6
web & api: rename stream to tunnel
...
- updated the endpoint to /tunnel
- updated status to tunnel
- fixed one incorrectly named error in web
2024-09-05 00:26:48 +06:00
dumbmoron
79237185bd
docs/api: update url
misspecification
2024-09-04 16:30:02 +00:00
dumbmoron
9800a9b54f
docs/api: update to reflect new request/response schema
2024-09-04 16:28:59 +00:00
wukko
f227abf6cb
docs/examples/compose: remove version top-level element
2024-08-03 22:09:35 +06:00
wukko
c57dce6806
docs/examples/compose: remove web example
2024-08-03 22:07:14 +06:00
wukko
f8a28c6c5f
docs/api: update info about picker item types
2024-07-26 22:02:59 +06:00
alina sireneva
a6623567e2
feat: support external proxies ( #588 )
2024-07-24 21:49:47 +06:00
dumbmoron
31e1fa5c5c
run-an-instance: remove slash from end of CORS_URL example
...
it's somewhat misleading, since this specifies the origin
(https://html.spec.whatwg.org/multipage/browsers.html#concept-origin-tuple ) and not a full URL
2024-07-20 12:53:59 +02:00
jj
2f4a013a2a
docs/api: use js-specific type for cors
in serverInfo response
...
there is no such thing as an int in js
2024-07-07 15:31:55 +02:00
wukko
ba75b90992
docs: update main instance api url
2024-05-22 07:54:38 +06:00