📝 Updated Docs

2026-04-25 03:48:37 +09:00 · 2022-11-02 22:08:09 +05:30
parent be42de0f4c
commit 5fb01a3ef9
1 changed files with 103 additions and 112 deletions
@@ -1,4 +1,4 @@
-# Docker-Py-ReVanced
+# 🤓Docker-Py-ReVanced

 A little python script that will help you in building Revanced and Revanced-Extended [apps](#note)

@@ -8,7 +8,7 @@ Revanced Extended.

 ## Pre-Built APKs

-You can get pre-built apks [here](https://t.me/revanced_apkss)
+You can get pre-built apks [here](https://revanced_apkss.t.me/)

 ## Build Yourself

@@ -16,123 +16,114 @@ You can use any of the following methods to build.

 - 🚀In GitHub (**_`Recommended`_**)

-    1. Fork the project.<br>
-       <img src="https://i.imgur.com/R5HdByI.png" width="400" style="left"><br>
-    2. Add `ENVS` (**optional**) secret to the repo. Required only if you want to cook specific apps/versions.
-        <details>
-          <summary>🚶Detailed step by step guide</summary>
+  1. Fork the project.<br>
+     <img src="https://i.imgur.com/R5HdByI.png" width="400" style="left"><br>
+  2. Add `ENVS` (**optional**) secret to the repo. Required only if you want to cook specific apps/versions.
+      <details>
+        <summary>🚶Detailed step by step guide</summary>

-        - Go to the repo settings and then to actions->secret<br>
-          <img src="https://i.imgur.com/Inj82KK.png" width="600" style="left"><br>
-        - Add Repository secret<br>
-          <img src="https://i.imgur.com/V2Wfx3J.png" width="600" style="left">
+     - Go to the repo settings and then to actions->secret<br>
+       <img src="https://i.imgur.com/Inj82KK.png" width="600" style="left"><br>
+     - Add Repository secret<br>
+       <img src="https://i.imgur.com/V2Wfx3J.png" width="600" style="left">

-       </details>
+     </details>

-    3. Go to actions tab. Select `Build & Release`.Click on `Run Workflow`.
+  3. Go to actions tab. Select `Build & Release`.Click on `Run Workflow`.

-       <details>
-         <summary>🚶Detailed step by step guide</summary>
+     <details>
+       <summary>🚶Detailed step by step guide</summary>

-        - Go to actions tab<br>
-          <img src="https://i.imgur.com/XSCvzav.png" width="600" style="left"><br>
-        - Check the status of build, It should look green.<br>
-          <img src="https://i.imgur.com/CsJt9W1.png" width="600" style="left">
+     - Go to actions tab<br>
+       <img src="https://i.imgur.com/XSCvzav.png" width="600" style="left"><br>
+     - Check the status of build, It should look green.<br>
+       <img src="https://i.imgur.com/CsJt9W1.png" width="600" style="left">

-       </details>
+     </details>

-    4. If the building process is successful, you’ll get your APKs in the <br>
-       <img src="https://i.imgur.com/S5d7qAO.png" width="700" style="left">
+  4. If the building process is successful, you’ll get your APKs in the <br>
+     <img src="https://i.imgur.com/S5d7qAO.png" width="700" style="left">

-<details>
-<summary>🐳With Docker Compose</summary>
+- 🐳With Docker Compose

-1. Install Docker(Skip if already installed)
-   ```bash
-   curl -fsSL https://get.docker.com -o get-docker.sh
-   sh get-docker.sh
-   ```
-2. Grant Permissions with(Skip if already there)
-   ```bash
-    sudo usermod -a -G docker ec2-user
-    sudo usermod -a -G docker $USER
-    sudo chmod 777 /var/run/docker.sock
-   ```
-3. Install Docker compose(Skip if already installed or using **_`Docker Desktop`_**)
-   ```bash
-   curl -L "https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-$(uname -s)-$(uname -m)" \
-   -o /usr/local/bin/docker-compose
-   sudo chmod +x /usr/local/bin/docker-compose
-   ```
-4. Clone the repo
-   ```bash
-   git clone https://github.com/nikhilbadyal/docker-py-revanced
-   ```
-5. cd to the cloned repo
-   ```bash
-   cd docker-py-revanced
-   ```
-6. Run script with
-   ```shell
-   docker-compose up
-   ```
+  1. Install Docker(Skip if already installed)
+     ```bash
+     curl -fsSL https://get.docker.com -o get-docker.sh
+     sh get-docker.sh
+     ```
+  2. Grant Permissions with(Skip if already there)
+     ```bash
+      sudo usermod -a -G docker ec2-user
+      sudo usermod -a -G docker $USER
+      sudo chmod 777 /var/run/docker.sock
+     ```
+  3. Install Docker compose(Skip if already installed or using **_`Docker Desktop`_**)
+     ```bash
+     curl -L "https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-$(uname -s)-$(uname -m)" \
+     -o /usr/local/bin/docker-compose
+     sudo chmod +x /usr/local/bin/docker-compose
+     ```
+  4. Clone the repo
+     ```bash
+     git clone https://github.com/nikhilbadyal/docker-py-revanced
+     ```
+  5. cd to the cloned repo
+     ```bash
+     cd docker-py-revanced
+     ```
+  6. Run script with
+     ```shell
+     docker-compose up
+     ```

-</details>
+- 🐳With Docker

-<details>
-<summary>🐳With Docker</summary>
+  1. Install Docker(Skip if already installed)
+     ```bash
+     curl -fsSL https://get.docker.com -o get-docker.sh
+     sh get-docker.sh
+     ```
+  2. Run script with
+     ```shell
+     docker run -v "$(pwd)"/apks:/app/apks/  nikhilbadyal/docker-py-revanced
+     ```
+     You can pass below envs with `-e` flag.

-1. Install Docker(Skip if already installed)
-   ```bash
-   curl -fsSL https://get.docker.com -o get-docker.sh
-   sh get-docker.sh
-   ```
-2. Run script with
-   ```shell
-   docker run -v "$(pwd)"/apks:/app/apks/  nikhilbadyal/docker-py-revanced
-   ```
-   You can pass below envs with `-e` flag.
+- 🫠Without Docker

-</details>
+  1. Install Java17 (zulu preferred)
+  2. Install Python
+  3. Create virtual environment
+     ```
+     python3 -m venv venv
+     ```
+  4. Activate virtual environment
+     ```
+     source venv/bin/activate
+     ```
+  5. Install Dependencies with
+     ```
+     pip install -r requirements.txt
+     ```
+  6. Run the script with
+     ```
+     python python main.py
+     ```

-<details>
-<summary>🫠Without Docker</summary>
-
-1. Install Java17 (zulu preferred)
-2. Install Python
-3. Create virtual environment
-   ```
-   python3 -m venv venv
-   ```
-4. Activate virtual environment
-   ```
-   source venv/bin/activate
-   ```
-5. Install Dependencies with
-   ```
-   pip install -r requirements.txt
-   ```
-6. Run the script with
-   ```
-   python python main.py
-   ```
-
-</details>
-
-### Note
+## Note

 (Pay attention to 3,4)<br>
 By default, script build the version as recommended by Revanced team.

 1. Supported values for **REVANCED_APPS_NAME** are :

-    1. youtube
-    2. youtube_music
-    3. twitter
-    4. reddit
-    5. tiktok
-    6. warnwetter
-    7. spotify
+   1. youtube
+   2. youtube_music
+   3. twitter
+   4. reddit
+   5. tiktok
+   6. warnwetter
+   7. spotify

 2. Remember to download the **_Microg_**. Otherwise, you will not be able to open YouTube.
 3. By default, it will build only `youtube`. To build other apps supported by revanced team.
@@ -213,19 +204,19 @@ By default, script build the version as recommended by Revanced team.
    BUILD_EXTENDED=False
   ```
 9. For Telegram Upload.
-    1. Set up a telegram channel, send a message to it and forward the message to
-       this telegram [bot](https://t.me/username_to_id_bot)
-    2. Copy `id` and save it to `TELEGRAM_CHAT_ID`<br>
-       <img src="https://i.imgur.com/22UiaWs.png" width="300" style="left"><br>
-    3. `TELEGRAM_BOT_TOKEN` - Telegram provides BOT_TOKEN. It works as sender. Open [bot](https://t.me/BotFather) and
-       create one copy api key<br>
-       <img src="https://i.imgur.com/A6JCyK2.png" width="300" style="left"><br>
-    4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)<br>
-       <img src="https://i.imgur.com/eha3nnb.png" width="300" style="left"><br>
-    5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)<br>
-       <img src="https://i.imgur.com/7n5k1mp.png" width="300" style="left"><br>
-    6. After Everything done successfully the actions secrets of the repository will look something like<br>
-       <img src="https://i.imgur.com/dzC1KFa.png" width="400">
+   1. Set up a telegram channel, send a message to it and forward the message to
+      this telegram [bot](https://t.me/username_to_id_bot)
+   2. Copy `id` and save it to `TELEGRAM_CHAT_ID`<br>
+      <img src="https://i.imgur.com/22UiaWs.png" width="300" style="left"><br>
+   3. `TELEGRAM_BOT_TOKEN` - Telegram provides BOT_TOKEN. It works as sender. Open [bot](https://t.me/BotFather) and
+      create one copy api key<br>
+      <img src="https://i.imgur.com/A6JCyK2.png" width="300" style="left"><br>
+   4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)<br>
+      <img src="https://i.imgur.com/eha3nnb.png" width="300" style="left"><br>
+   5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)<br>
+      <img src="https://i.imgur.com/7n5k1mp.png" width="300" style="left"><br>
+   6. After Everything done successfully the actions secrets of the repository will look something like<br>
+      <img src="https://i.imgur.com/dzC1KFa.png" width="400">
 10. Configuration defined in `ENVS` in `GitHub secrets` will override the configuration in `.env` file. You can use this
    fact to define your normal configurations in `.env` file and sometimes if you want to build something different just
    once. Add it in `GitHub secrets` or you can ignore `.env` file and always use `GitHub secrets` because to modify