mirror of
https://github.com/knightcrawler-stremio/knightcrawler.git
synced 2024-12-20 03:29:51 +00:00
Add Getting started and WIP: Run Knight Crawler
This commit is contained in:
@@ -6,7 +6,8 @@
|
|||||||
start-page="Overview.md">
|
start-page="Overview.md">
|
||||||
|
|
||||||
<toc-element topic="Overview.md"/>
|
<toc-element topic="Overview.md"/>
|
||||||
<toc-element topic="How-to.md">
|
<toc-element topic="Getting-started.md">
|
||||||
|
<toc-element topic="Run-Knight-Crawler.md"/>
|
||||||
</toc-element>
|
</toc-element>
|
||||||
<toc-element topic="Supported-Debrid-services.md"/>
|
<toc-element topic="Supported-Debrid-services.md"/>
|
||||||
</instance-profile>
|
</instance-profile>
|
||||||
15
docs/Writerside/topics/Getting-started.md
Normal file
15
docs/Writerside/topics/Getting-started.md
Normal file
@@ -0,0 +1,15 @@
|
|||||||
|
# Getting started
|
||||||
|
|
||||||
|
Knight Crawler is provided as an all-in-one solution. This means that you can get started with very little setup.
|
||||||
|
|
||||||
|
In its initial state Knight Crawler will only work on the machine that you host it on, and will not be accessible on
|
||||||
|
your local network or from the internet. This is a Stremio limitation ([read Stremio's stance here](https://github.com/Stremio/stremio-features/issues/687)) and is beyond our control. We provide a guide
|
||||||
|
how to make Knight Crawler accessible from your local network or the internet [here]().
|
||||||
|
|
||||||
|
## Before you start
|
||||||
|
|
||||||
|
Make sure that you have:
|
||||||
|
- A place to host Knight Crawler
|
||||||
|
- [Docker](https://docs.docker.com/get-docker/) and [Compose](https://docs.docker.com/compose/install/) installed
|
||||||
|
- A [GitHub](https://github.com/) account _(optional)_
|
||||||
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
# How to
|
|
||||||
|
|
||||||
A How-to article is an action-oriented type of document.
|
|
||||||
It explains how to perform a specific task or solve a problem, and usually contains a sequence of steps.
|
|
||||||
Start with a short introductory paragraph that explains what users will accomplish by following this procedure,
|
|
||||||
what they need to perform it for, or define the target audience of the doc.
|
|
||||||
|
|
||||||
> **Highlight important information**
|
|
||||||
>
|
|
||||||
> You can change the element to *tip* or *warning* by renaming the style attribute below.
|
|
||||||
>
|
|
||||||
{style="note"}
|
|
||||||
|
|
||||||
## Before you start
|
|
||||||
|
|
||||||
It is good practice to list the prerequisites that are required or recommended.
|
|
||||||
|
|
||||||
Make sure that:
|
|
||||||
- First prerequisite
|
|
||||||
- Second prerequisite
|
|
||||||
|
|
||||||
## How to perform a task
|
|
||||||
|
|
||||||
Some introductory information.
|
|
||||||
|
|
||||||
1. Step with a code block
|
|
||||||
|
|
||||||
```bash
|
|
||||||
run this --that
|
|
||||||
```
|
|
||||||
|
|
||||||
2. Step with a [link](https://www.jetbrains.com)
|
|
||||||
|
|
||||||
3. Step with a list.
|
|
||||||
- List item
|
|
||||||
- List item
|
|
||||||
- List item
|
|
||||||
21
docs/Writerside/topics/Run-Knight-Crawler.md
Normal file
21
docs/Writerside/topics/Run-Knight-Crawler.md
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
# Run Knight Crawler
|
||||||
|
|
||||||
|
To run Knight Crawler you need two files, both can be found in the [deployment/docker](https://github.com/Gabisonfire/knightcrawler/tree/master/deployment/docker)
|
||||||
|
directory on GitHub:
|
||||||
|
|
||||||
|
- <path>deployment/docker/.env.example</path>
|
||||||
|
|
||||||
|
- <path>deployment/docker/docker-compose.yaml</path>.
|
||||||
|
|
||||||
|
For this guide I will be placing them in a directory on my home drive <path>~/knightcrawler</path>.
|
||||||
|
|
||||||
|
Rename the <path>.env.example</path> file to be <path>.env</path>
|
||||||
|
|
||||||
|
```
|
||||||
|
~/
|
||||||
|
└── knightcrawler/
|
||||||
|
├── .env
|
||||||
|
└── docker-compose.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
Before we start the services, we need to
|
||||||
Reference in New Issue
Block a user