Merge pull request #497 from whimsical-c4lic0/add-docs

Add docs

.github/workflows/publish-docs.yml

@@ -0,0 +1,66 @@
+name: Publish docs
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'OFDLV*'
+    paths:
+      - 'docs/**'
+      - '.github/workflows/publish-docs.yml'
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./docs
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: './docs/.nvmrc'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build with docusaurus
+        run: npm run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './docs/build'
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -7,7 +7,7 @@ Scrape all the media from an OnlyFans account
 Join the discord [here](https://discord.com/invite/6bUW8EJ53j)
 
 # Documentation
-Please refer to https://of-dl.gitbook.io/of-dl/ for instuctions on:
+Please refer to https://sim0n00ps.github.io/OF-DL/ for instructions on:
 - Requirements
 - Installing the Program
 - Running the Program
@@ -28,7 +28,7 @@ https://github.com/sim0n00ps/OF-DL/assets/132307467/95fbb3cb-adcb-4fe5-995d-a39a
 If you have any questions or issues please raise them on here, all I ask is that you please look back through previous issues to see if your issue or question has been fixed/answered already, it gets annoying when people create issues without checking previous issues which usually leads to me or others repeating themselves, thank you.
 
 # Disclaimers
-This tool is not associated or involved with Onlyfans in any way. 
+This tool is not associated or involved with Onlyfans in any way.
 I am not responsible for anything that happens to you or your account when using the tool.
 
 # Donations

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/.nvmrc

@@ -0,0 +1 @@
+20.16.0

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/docs/config/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Configuration",
+  "position": 2,
+  "link": {
+    "type": "generated-index",
+    "description": "Configuration options and information for OF-DL"
+  }
+}

docs/docs/config/auth.md

@@ -0,0 +1,57 @@
+---
+sidebar_position: 1
+---
+
+# Authentication
+
+After you have downloaded the latest release the first thing to do is to fill out the `auth.json` file.
+
+## Browser Extension
+
+You can use a browser extension to help get the required info for the `auth.json` file. The extension supports Google Chrome and Firefox and can be found [here](https://github.com/whimsical-c4lic0/OF-DL-Auth-Helper/) (https://github.com/whimsical-c4lic0/OF-DL-Auth-Helper/).
+
+## Manual Method
+
+Open `auth.json` in a text editor of your choice. The default windows notepad is sufficient. When you open `auth.json` for the first time you should see something like this:
+
+```json
+{
+    "USER_ID": "",
+    "USER_AGENT": "",
+    "X_BC": "",
+    "COOKIE": ""
+}
+```
+
+Next, log into OnlyFans, and press F12 to open the dev tools. In the filter box, type `api`, and open any page on OnlyFans (e.g. Messages). You should see some requests appear in the list within the network tab:
+
+![Image of dev tools panel showing network tab](/img/network_tab.png)
+
+Click on one of the requests you see in the list, and scroll down until you find the 'Request Headers' section.
+
+![Image of dev tools panel showing request headers](/img/request_headers.png)
+
+You should be able to find the 3 fields we need, `Cookie`, `User-Agent` and `x-bc`.
+
+Within Cookie you will find 2 bits of information that we need to copy, these being `sess` and `auth_id`.
+
+So heading back to your text editor:
+
+The value of `USER_ID` will be set to what `auth_id` is set to.
+
+The value of `USER_AGENT` will be set to what the `User-Agent` is set to in the Request Headers.
+
+The value of `X_BC` will be set to what the `X-Bc` is set to in the Request Headers.
+
+The value of `COOKIE` will be set to `auth_id=YOUR AUTH_ID HERE; sess=YOUR SESS HERE;`, please make sure you copy the values from within the Cookie field found in the Request Headers section.
+
+If you have done everything correct you should end up with something like this (this is all dummy info):
+
+```json
+{
+  "USER_ID": "123456",
+  "USER_AGENT": "Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:121.0) Gecko/20100101 Firefox/121.0",
+  "X_BC": "2a9b28a68e7c03a9f0d3b98c28d70e8105e1f1df",
+  "COOKIE": "auth_id=123456; sess=k3s9tnzdc8vt2h47ljxpmwqy5r;"
+}
+```

docs/docs/config/cdm.md

@@ -0,0 +1,15 @@
+---
+sidebar_position: 4
+---
+
+# CDM (optional)
+
+:::warning
+
+Please skip this if you are not very technical with computers.
+
+:::
+
+Two files can be generated called `device_client_id_blob` and `device_private_key`. These are used to get the decryption keys needed for downloading DRM videos.
+You can find a tutorial on how to do this [here](https://forum.videohelp.com/threads/408031-Dumping-Your-own-L3-CDM-with-Android-Studio), you will need to place `device_client_id_blob` and `device_private_key` files in `cdm/devices/chrome_1610/`.
+I have also made some batch scripts to run the commands included in the guide linked above (https://github.com/sim0n00ps/L3-Dumping) that can save you some time and makes the process a little simpler. You will still be able to download DRM protected videos without these files, all these files do is allow you to still be able to download DRM videos if cdrm-project (the website used if you don't have these files) goes down.