doc -> docs as Github needs a specific name

This commit is contained in:
Gabe Kangas
2022-03-19 12:02:34 -07:00
parent 5d360bcdd5
commit d3aa3f87af
5 changed files with 3 additions and 3 deletions

19
docs/SECURITY.md Normal file
View File

@@ -0,0 +1,19 @@
# Security Policy
Owncast appreciates efforts to improve the security of the software
and follow the [GitHub coordinated disclosure of security vulnerabilities](https://docs.github.com/en/code-security/security-advisories/about-coordinated-disclosure-of-security-vulnerabilities#about-reporting-and-disclosing-vulnerabilities-in-projects-on-github)
for responsible disclosure and prompt mitigation.
## Supported Versions
The latest version of Owncast is seen as the supported version. As a small project we are unable to support previous versions and urge users of the software to stay up to date.
## Reporting a Vulnerability
To report a security issue with Owncast, [open an issue](https://github.com/owncast/owncast/issues/new
) on the Owncast GitHub repository and *do not* mention vulnerability details in the issue. If you have a preferred next step on where to discuss the details of the disclosure, please mention that in the issue if it's appropriate for those details to be public.
You may optionally [email Gabe](mailto:gabek@real-ity.com) to alert him directly and provide specifics on how you wish to disclose the details of the issue.
Owncast may open a draft [GitHub Security Advisory](https://docs.github.com/en/code-security/security-advisories/creating-a-security-advisory)
to discuss the vulnerability details in private if it is warranted.

2371
docs/api/index.html Normal file

File diff suppressed because one or more lines are too long

63
docs/dependencies.md Normal file
View File

@@ -0,0 +1,63 @@
Owncast Dependencies
# Owncast Core
## Frontend
- video.js https://github.com/videojs/video.js
- Emoji-button https://github.com/joeattardi/emoji-button
- Preact https://github.com/preactjs/preact
- Htm https://github.com/developit/htm
- Mark.js https://github.com/julmot/mark.js
- Micromodal https://github.com/ghosh/micromodal
- Tailwind CSS https://tailwindcss.com/
## Backend
- AWS SDK for Go https://aws.amazon.com/sdk-for-go/
- Gorilla Websocket https://github.com/gorilla/websocket
- m3u8 HLS parser and writer https://github.com/grafov/m3u8
- Log rotation https://github.com/lestrrat-go/file-rotatelogs
- Pkger file embeds https://github.com/markbates/pkger
- sqlite database driver https://github.com/mattn/go-sqlite3
- Bluemonday HTML sanitizer https://github.com/microcosm-cc/bluemonday
- User agent parser https://github.com/mssola/user_agent
- joy5 RTMP protocol https://github.com/nareix/joy5
- Unofficial MaxMind GeoIP2 Reader for Go https://github.com/oschwald/geoip2-golang
- For dumping SQL text https://github.com/schollz/sqlite3dump
- Logging library https://github.com/sirupsen/logrus
- ID string generator https://github.com/teris-io/shortid
- Markdown parser https://github.com/yuin/goldmark
# Owncast Admin
- React component library https://reactjs.org/
- Ant design https://ant.design
- Chart.js chart library https://github.com/chartjs
- react-chartkick component https://chartkick.com/react
- date-fns time/date library https://date-fns.org/
- markdown-it Javascript markdown parser https://github.com/markdown-it/markdown-it
- nextjs web framework https://nextjs.org/
- ua-parser-js user-agent parser https://github.com/faisalman/ua-parser-js
- Markdown editor component https://github.com/HarryChen0506/react-markdown-editor-lite
- sass styling https://sass-lang.com/
# Owncast Directory
## Frontend
- Ant design https://ant.design
- date-fns time/date library https://date-fns.org/
- nextjs web framework https://nextjs.org/
- React component library https://reactjs.org/
- sass styling https://sass-lang.com/
## Backend
- HTTP routing https://github.com/gorilla/mux
- Mastodon API https://github.com/mattn/go-mastodon
- Twitter API https://github.com/ChimeraCoder/anaconda
- Go ORM https://gorm.io/gorm
- ID string generator https://github.com/teris-io/shortid
- Slug generator https://github.com/metal3d/go-slugify
- Logging library https://github.com/sirupsen/logrus