mirror of
https://github.com/imputnet/cobalt.git
synced 2025-07-24 06:08:27 +00:00
markdown consistency fixes
This commit is contained in:
parent
40c17f6e33
commit
149e4dcf10
10
.github/ISSUE_TEMPLATE/bug-report.md
vendored
10
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@ -7,23 +7,23 @@ assignees: ''
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**bug description**
|
# bug description
|
||||||
a clear and concise description of what the bug is.
|
a clear and concise description of what the bug is.
|
||||||
|
|
||||||
**reproduction steps**
|
# reproduction steps
|
||||||
steps to reproduce the behavior:
|
steps to reproduce the behavior:
|
||||||
1. go to '...'
|
1. go to '...'
|
||||||
2. click on '....'
|
2. click on '....'
|
||||||
3. download this video: **[link here]**
|
3. download this video: **[link here]**
|
||||||
4. see error
|
4. see error
|
||||||
|
|
||||||
**screenshots**
|
# screenshots
|
||||||
if applicable, add screenshots or screen recordings to help explain your problem.
|
if applicable, add screenshots or screen recordings to help explain your problem.
|
||||||
|
|
||||||
**links**
|
# links
|
||||||
if applicable, add links that cause the issue. more = better.
|
if applicable, add links that cause the issue. more = better.
|
||||||
|
|
||||||
**platform**
|
# platform
|
||||||
- OS [e.g. iOS, windows]
|
- OS [e.g. iOS, windows]
|
||||||
- browser [e.g. chrome, safari, firefox]
|
- browser [e.g. chrome, safari, firefox]
|
||||||
- version [e.g. 115]
|
- version [e.g. 115]
|
||||||
|
6
.github/ISSUE_TEMPLATE/feature-request.md
vendored
6
.github/ISSUE_TEMPLATE/feature-request.md
vendored
@ -7,11 +7,11 @@ assignees: ''
|
|||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**describe the feature you'd like to see**
|
# describe the feature you'd like to see
|
||||||
a clear and concise description of what you want to happen.
|
a clear and concise description of what you want to happen.
|
||||||
|
|
||||||
**describe alternatives you've considered**
|
# describe alternatives you've considered
|
||||||
a clear and concise description of any alternative solutions or features you've considered.
|
a clear and concise description of any alternative solutions or features you've considered.
|
||||||
|
|
||||||
**additional context**
|
# additional context
|
||||||
add any other context or screenshots about the feature request here.
|
add any other context or screenshots about the feature request here.
|
||||||
|
@ -56,6 +56,7 @@ you can use the main api instance ([co.wuk.sh](https://co.wuk.sh/)) in your proj
|
|||||||
|
|
||||||
## how to run your own instance
|
## 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).
|
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.
|
it's *highly* recommended to use a docker compose method unless you run for developing/debugging purposes.
|
||||||
|
|
||||||
## sponsors
|
## sponsors
|
||||||
|
10
docs/api.md
10
docs/api.md
@ -1,18 +1,19 @@
|
|||||||
# cobalt api documentation
|
# cobalt api documentation
|
||||||
this document provides info about methods and acceptable variables for all cobalt api requests.
|
this document provides info about methods and acceptable variables for all cobalt api requests.
|
||||||
|
|
||||||
```
|
```yml
|
||||||
👍 you can use co.wuk.sh instance in your projects for free, just don't be an asshole.
|
# 👍 you can use co.wuk.sh instance in your projects for free, just don't be an asshole.
|
||||||
```
|
```
|
||||||
|
|
||||||
## POST: `/api/json`
|
## POST: `/api/json`
|
||||||
cobalt's main processing endpoint.
|
cobalt's main processing endpoint.
|
||||||
|
|
||||||
request body type: `application/json`
|
request body type: `application/json`
|
||||||
|
|
||||||
response body type: `application/json`
|
response body type: `application/json`
|
||||||
|
|
||||||
```
|
```yml
|
||||||
⚠️ you must include Accept and Content-Type headers with every POST /api/json request.
|
# ⚠️ you must include Accept and Content-Type headers with every POST /api/json request.
|
||||||
|
|
||||||
Accept: application/json
|
Accept: application/json
|
||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
@ -66,6 +67,7 @@ cobalt's live render (or stream) endpoint. used for sending various media conten
|
|||||||
|
|
||||||
## GET: `/api/serverInfo`
|
## GET: `/api/serverInfo`
|
||||||
returns current basic server info.
|
returns current basic server info.
|
||||||
|
|
||||||
response body type: `application/json`
|
response body type: `application/json`
|
||||||
|
|
||||||
### response body variables
|
### response body variables
|
||||||
|
@ -8,20 +8,25 @@ if you need help with installing docker, follow *only the first step* of these t
|
|||||||
|
|
||||||
## how to run a cobalt docker package:
|
## how to run a cobalt docker package:
|
||||||
1. create a folder for cobalt config file, something like this:
|
1. create a folder for cobalt config file, something like this:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
mkdir cobalt
|
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
|
```sh
|
||||||
cd cobalt && nano docker-compose.yml
|
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](https://github.com/wukko/cobalt/blob/current/docs/examples/docker-compose.example.yml) for either web or api instance (or both, if you wish) and edit it to your needs.
|
3. copy and paste the [sample config from here](https://github.com/wukko/cobalt/blob/current/docs/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.
|
|
||||||
|
**make sure to replace default URLs with your own or cobalt won't work correctly.**
|
||||||
|
|
||||||
4. finally, start the cobalt container (from cobalt directory):
|
4. finally, start the cobalt container (from cobalt directory):
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
```
|
```
|
||||||
|
@ -1,8 +1,11 @@
|
|||||||
# self-troubleshooting cobalt
|
# self-troubleshooting cobalt
|
||||||
```
|
|
||||||
|
```txt
|
||||||
🚧 this page is work-in-progress. expect more guides to be added in the future!
|
🚧 this page is work-in-progress. expect more guides to be added in the future!
|
||||||
```
|
```
|
||||||
|
|
||||||
if any issues occur while using cobalt, you can fix many of them yourself. this document aims to provide guides on how to fix most complicated of them.
|
if any issues occur while using cobalt, you can fix many of them yourself. this document aims to provide guides on how to fix most complicated of them.
|
||||||
|
|
||||||
use wiki navigation on right to jump between solutions.
|
use wiki navigation on right to jump between solutions.
|
||||||
|
|
||||||
## how to fix clipboard pasting in firefox
|
## how to fix clipboard pasting in firefox
|
||||||
@ -14,7 +17,10 @@ you can fix this issue by changing a single preference in `about:config`.
|
|||||||

|

|
||||||
|
|
||||||
2. if asked, read what firefox has to say and press "accept the risk and continue".
|
2. if asked, read what firefox has to say and press "accept the risk and continue".
|
||||||
⚠ tinkering with other preferences may break your browser. **do not** edit them unless you know what you're doing.
|
|
||||||
|
```txt
|
||||||
|
⚠ tinkering with other preferences may break your browser. **do not** edit them unless you know what you're doing.
|
||||||
|
```
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user