everywall · joncrangle · Dec 20, 2023 · Dec 22, 2023 · Dec 22, 2023 · Dec 22, 2023
diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,4 @@
 
 npm-debug.log*
 yarn-debug.log*
-yarn-error.log*
+yarn-error.log*
diff --git a/blog/2019-05-28-first-blog-post.md b/blog/2019-05-28-first-blog-post.md
diff --git a/blog/2019-05-29-long-blog-post.md b/blog/2019-05-29-long-blog-post.md
diff --git a/blog/2021-08-01-mdx-blog-post.mdx b/blog/2021-08-01-mdx-blog-post.mdx
diff --git a/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg b/blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
diff --git a/blog/2021-08-26-welcome/index.md b/blog/2021-08-26-welcome/index.md
diff --git a/blog/authors.yml b/blog/authors.yml
diff --git a/docs/developer/_category_.json b/docs/developer/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Developer",
+  "position": 5
+}
diff --git a/docs/developer/contribute.md b/docs/developer/contribute.md
@@ -0,0 +1,35 @@
+---
+sidebar_position: 2
+---
+
+# Contribute
+
+Thanks for your interest in contributing to Ladder.
+
+Please take a moment to review this page before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.
+
+## Contribute rules
+
+1. Test your rule with a variety of browsers and on both mobile & desktop devices.
+
+2. Open a pull request in the [everywall/ladder-rules](https://github.com/everywall/ladder-rules) repository.
+
+> To prevent rulesets from getting disorganized, rulesets are saved in a directory structure according to the site's country.
+
+## Contribute to Ladder
+
+### New feature guidelines
+
+New features should be linked to an existing feature request. If you have ideas for a larger feature, please open an issue first.
+
+1. Fork or clone the repo
+
+2. Create a new branch to work on your bug fix or feature
+
+3. Open a pull request in the [everywall/ladder](https://github.com/everywall/ladder) repository.
+
+Ladder is a a [Go Fiber](https://gofiber.io/) application. Please see their documentation for more information about the Go Fiber framework.
+
+### Documentation
+
+The documentation for this project is located at [everywall/everywall.github.io](https://github.com/everywall/everywall.github.io). When contributing a feature, please make an accompanying pull request to update documentation, if applicable.
diff --git a/docs/developer/setup.md b/docs/developer/setup.md
@@ -0,0 +1,41 @@
+---
+sidebar_position: 1
+---
+
+# Setup
+
+## Development server
+
+:::info
+
+Optional: To run a development server with live-reload using [cosmtrek/air](https://github.com/cosmtrek/air)
+
+1. Install air according to the [installation instructions](https://github.com/cosmtrek/air#installation).
+
+2. Clone the project repo:
+
+```bash
+git clone [email protected]:everywall/ladder.git
+```
+
+3. Run a development server at http://localhost:8080:
+
+```bash
+air
+```
+
+:::
+
+Run a development server at http://localhost:8080:
+
+```bash
+git clone [email protected]:everywall/ladder.git
+git submodule update --init --recursive
+echo "dev  " > handlers/VERSION
+echo "dev  " > cmd/VERSION
+RULESET="./ruleset.yaml" go run cmd/main.go
+```
+
+## Tailwind CSS
+
+This project uses [pnpm](https://pnpm.io/) to build a stylesheet with the [Tailwind CSS](https://tailwindcss.com/) classes. For local development, if you modify styles in `form.html`, `playground.html`, `generate_readable_outline.html` or `error_page.html`, run `pnpm build` to generate a new stylesheet.
diff --git a/docs/install/_category_.json b/docs/install/_category_.json
@@ -0,0 +1,4 @@
+{
+  "label": "Install",
+  "position": 2
+}
diff --git a/docs/install/binary.md b/docs/install/binary.md
@@ -0,0 +1,15 @@
+---
+sidebar_position: 2
+---
+
+# Binary
+
+:::caution
+
+If your instance will be publicly accessible, make sure to enable Basic Auth. This will prevent unauthorized users from using your proxy. If you do not enable Basic Auth, anyone can use your proxy to browse nasty/illegal stuff. And you will be responsible for it.
+
+:::
+
+1. Download the binary for your OS [here](https://github.com/everywall/ladder/releases/latest)
+2. Unpack and run the binary `./ladder -r https://t.ly/14PSf`
+3. Open Browser (Default: http://localhost:8080)
diff --git a/docs/install/docker.md b/docs/install/docker.md
@@ -0,0 +1,36 @@
+---
+sidebar_position: 1
+---
+
+# Docker
+
+:::caution
+
+If your instance will be publicly accessible, make sure to enable Basic Auth. This will prevent unauthorized users from using your proxy. If you do not enable Basic Auth, anyone can use your proxy to browse nasty/illegal stuff. And you will be responsible for it.
+
+:::
+
+## Docker compose
+
+```yaml title="docker-compose.yaml"
+version: "3"
+services:
+  ladder:
+    image: ghcr.io/everywall/ladder:latest
+    container_name: ladder
+    build: .
+    restart: always
+    environment:
+      - PORT=8080
+      - RULESET=https://raw.githubusercontent.com/everywall/ladder-rules/main/rulesets
+    ports:
+      - "8080:8080"
+```
+
+Other environment variables can be updated as to your preferences, with details on each variable listed in [environment variables](environment-variables.md).
+
+## Docker run
+
+```bash
+docker run -p 8080:8080 -d --env RULESET=https://t.ly/DA3n6 --name ladder ghcr.io/everywall/ladder:latest
+```
diff --git a/docs/install/environment-variables.md b/docs/install/environment-variables.md
@@ -0,0 +1,22 @@
+---
+sidebar_position: 4
+---
+
+# Environment variables
+
+| Variable                  | Description                                                     | Default Value                                                                                                                |
+| ------------------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| `PORT`                    | Port to listen on                                               | `8080`                                                                                                                       |
+| `PREFORK`                 | Spawn multiple server instances                                 | `false`                                                                                                                      |
+| `USER_AGENT`              | User agent to emulate                                           | `Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)`                                                   |
+| `X_FORWARDED_FOR`         | IP forwarder address                                            | `66.249.66.1`                                                                                                                |
+| `USERPASS`                | Enables Basic Auth, format `admin:123456`                       | ``                                                                                                                           |
+| `LOG_URLS`                | Log fetched URL's                                               | `true`                                                                                                                       |
+| `DISABLE_FORM`            | Disables URL Form Frontpage                                     | `false`                                                                                                                      |
+| `FORM_PATH`               | Path to custom Form HTML                                        | ``                                                                                                                           |
+| `RULESET`                 | Path or URL to a ruleset file, accepts local directories        | `https://raw.githubusercontent.com/everywall/ladder-rules/main/rulesets` or `/path/to/my/rules.yaml` or `/path/to/my/rules/` |
+| `EXPOSE_RULESET`          | Make your Ruleset available to other ladders                    | `true`                                                                                                                       |
+| `ALLOWED_DOMAINS`         | Comma separated list of allowed domains. Empty = no limitations | ``                                                                                                                           |
+| `ALLOWED_DOMAINS_RULESET` | Allow Domains from Ruleset. false = no limitations              | `false`                                                                                                                      |
+
+`ALLOWED_DOMAINS` and `ALLOWED_DOMAINS_RULESET` are joined together. If both are empty, no limitations are applied.
diff --git a/docs/install/kubernetes.md b/docs/install/kubernetes.md
@@ -0,0 +1,44 @@
+---
+sidebar_position: 3
+---
+
+# Kubernetes
+
+:::caution
+
+If your instance will be publicly accessible, make sure to enable Basic Auth. This will prevent unauthorized users from using your proxy. If you do not enable Basic Auth, anyone can use your proxy to browse nasty/illegal stuff. And you will be responsible for it.
+
+:::
+
+You can deploy Ladder on Kubernetes using the [Helm chart](https://github.com/everywall/ladder/tree/main/helm-chart).
+
+## Deployment prerequisites
+
+### Values
+
+Edit the values to your own preferences, with the only minimum requirement being `ingress.HOST` (line 19) being updated to your intended domain name.
+
+Other variables in `values.yaml` can be updated as to your preferences, with details on each variable listed in [environment variables](environment-variables.md).
+
+### Defaults in Kubernetes
+
+No ingress default has been specified.
+You can set this manually by adding an annotation to the ingress.yaml - if needed.  
+For example, to use Traefik -
+
+```yaml
+metadata:
+  name: ladder-ingress
+  annotations:
+    kubernetes.io/ingress.class: traefik
+```
+
+## Helm Install
+
+`helm install <name> <location> -n <namespace-name> --create-namespace`  
+`helm install ladder .\ladder\ -n ladder --create-namespace`
+
+## Helm Upgrade
+
+`helm upgrade <name> <location> -n <namespace-name>`  
+`helm upgrade ladder .\ladder\ -n ladder`
diff --git a/docs/intro.md b/docs/intro.md
diff --git a/docs/tutorial-extras/_category_.json → docs/modifiers/_category_.json b/docs/tutorial-extras/_category_.json → docs/modifiers/_category_.json
@@ -1,6 +1,6 @@
 {
-  "label": "Tutorial - Extras",
-  "position": 3,
+  "label": "Modifiers",
+  "position": 4,
   "link": {
     "type": "generated-index"
   }