diff --git a/README.md b/README.md index 835d6de..4dbdab5 100644 --- a/README.md +++ b/README.md @@ -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.
-
- 2. Add `ENVS` (**optional**) secret to the repo. Required only if you want to cook specific apps/versions. -
- 🚶Detailed step by step guide + 1. Fork the project.
+
+ 2. Add `ENVS` (**optional**) secret to the repo. Required only if you want to cook specific apps/versions. +
+ 🚶Detailed step by step guide - - Go to the repo settings and then to actions->secret
-
- - Add Repository secret
- + - Go to the repo settings and then to actions->secret
+
+ - Add Repository secret
+ -
+
- 3. Go to actions tab. Select `Build & Release`.Click on `Run Workflow`. + 3. Go to actions tab. Select `Build & Release`.Click on `Run Workflow`. -
- 🚶Detailed step by step guide +
+ 🚶Detailed step by step guide - - Go to actions tab
-
- - Check the status of build, It should look green.
- + - Go to actions tab
+
+ - Check the status of build, It should look green.
+ -
+
- 4. If the building process is successful, you’ll get your APKs in the
- + 4. If the building process is successful, you’ll get your APKs in the
+ -
-🐳With Docker Compose +- 🐳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 + ``` -
+- 🐳With Docker -
-🐳With Docker + 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 -
+ 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 + ``` -
-🫠Without Docker - -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 - ``` - -
- -### Note +## Note (Pay attention to 3,4)
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`
-
- 3. `TELEGRAM_BOT_TOKEN` - Telegram provides BOT_TOKEN. It works as sender. Open [bot](https://t.me/BotFather) and - create one copy api key
-
- 4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)
-
- 5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)
-
- 6. After Everything done successfully the actions secrets of the repository will look something like
- + 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`
+
+ 3. `TELEGRAM_BOT_TOKEN` - Telegram provides BOT_TOKEN. It works as sender. Open [bot](https://t.me/BotFather) and + create one copy api key
+
+ 4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)
+
+ 5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)
+
+ 6. After Everything done successfully the actions secrets of the repository will look something like
+ 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