sjva/docker-py-revanced
1
0
Fork 0
mirror of https://github.com/sotam0316/docker-py-revanced.git synced 2026-04-25 11:58:37 +09:00
Code Issues Packages Projects Releases Wiki Activity

📝 Updated Docs

Browse Source
This commit is contained in:
Nikhil Badyal
2022-11-02 21:41:34 +05:30
parent 57bd895580
commit be42de0f4c
1 changed files with 40 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+28 -43
View File
@@ -15,16 +15,17 @@ You can get pre-built apks [here](https://t.me/revanced_apkss)
You can use any of the following methods to build. You can use any of the following methods to build.
- 🚀In GitHub (**_`Recommended`_**) - 🚀In GitHub (**_`Recommended`_**)
1. Fork the project.
![fork] 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. 2. Add `ENVS` (**optional**) secret to the repo. Required only if you want to cook specific apps/versions.
<details> <details>
<summary>🚶Detailed step by step guide</summary> <summary>🚶Detailed step by step guide</summary>
- Go to the repo settings and then to actions->secret - Go to the repo settings and then to actions->secret<br>
![step_1] <img src="https://i.imgur.com/Inj82KK.png" width="600" style="left"><br>
- Add Repository secret - Add Repository secret<br>
![step_2] <img src="https://i.imgur.com/V2Wfx3J.png" width="600" style="left">
</details> </details>
@@ -33,14 +34,15 @@ You can use any of the following methods to build.
<details> <details>
<summary>🚶Detailed step by step guide</summary> <summary>🚶Detailed step by step guide</summary>
- Go to actions tab - Go to actions tab<br>
![action_0] <img src="https://i.imgur.com/XSCvzav.png" width="600" style="left"><br>
- Check the status of build, It should look green. - Check the status of build, It should look green.<br>
![build_wait] <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 ![apks] 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> <details>
<summary>🐳With Docker Compose</summary> <summary>🐳With Docker Compose</summary>
@@ -55,7 +57,7 @@ You can use any of the following methods to build.
sudo usermod -a -G docker ec2-user sudo usermod -a -G docker ec2-user
sudo usermod -a -G docker $USER sudo usermod -a -G docker $USER
sudo chmod 777 /var/run/docker.sock sudo chmod 777 /var/run/docker.sock
```` ```
3. Install Docker compose(Skip if already installed or using **_`Docker Desktop`_**) 3. Install Docker compose(Skip if already installed or using **_`Docker Desktop`_**)
```bash ```bash
curl -L "https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-$(uname -s)-$(uname -m)" \ curl -L "https://github.com/docker/compose/releases/download/v2.10.2/docker-compose-$(uname -s)-$(uname -m)" \
@@ -93,7 +95,6 @@ You can use any of the following methods to build.
</details> </details>
<details> <details>
<summary>🫠Without Docker</summary> <summary>🫠Without Docker</summary>
@@ -123,7 +124,8 @@ You can use any of the following methods to build.
(Pay attention to 3,4)<br> (Pay attention to 3,4)<br>
By default, script build the version as recommended by Revanced team. By default, script build the version as recommended by Revanced team.
1. Supported values for **_<REVANCED_APPS_NAME>_** are : 1. Supported values for **REVANCED_APPS_NAME** are :
1. youtube 1. youtube
2. youtube_music 2. youtube_music
3. twitter 3. twitter
@@ -178,10 +180,13 @@ By default, script build the version as recommended by Revanced team.
6. If you want to build `latest` version, whatever latest is available(including 6. If you want to build `latest` version, whatever latest is available(including
beta) . beta) .
Add `latest` in `.env` file or in `ENVS` in `GitHub secrets` (Recommended) in the format Add `latest` in `.env` file or in `ENVS` in `GitHub secrets` (Recommended) in the format
```ini ```ini
<APPNAME>_VERSION=latest <APPNAME>_VERSION=latest
``` ```
Example: Example:
```ini ```ini
YOUTUBE_VERSION=latest YOUTUBE_VERSION=latest
YOUTUBE_MUSIC_VERSION=latest YOUTUBE_MUSIC_VERSION=latest
@@ -211,14 +216,14 @@ By default, script build the version as recommended by Revanced team.
1. Set up a telegram channel, send a message to it and forward the message to 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) this telegram [bot](https://t.me/username_to_id_bot)
2. Copy `id` and save it to `TELEGRAM_CHAT_ID`<br> 2. Copy `id` and save it to `TELEGRAM_CHAT_ID`<br>
![chat id] <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 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> create one copy api key<br>
![bot api] <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> 4. `TELEGRAM_API_ID` - Telegram API_ID is provided by telegram [here](https://my.telegram.org/apps)<br>
![tg api] <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> 5. `TELEGRAM_API_HASH` - Telegram API_HASH is provided by telegram [here](https://my.telegram.org/apps)<br>
![tg api hash] <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> 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"> <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 10. Configuration defined in `ENVS` in `GitHub secrets` will override the configuration in `.env` file. You can use this
@@ -227,15 +232,18 @@ By default, script build the version as recommended by Revanced team.
`.env` you need to modify the repo. Edit it and make a commit. `.env` you need to modify the repo. Edit it and make a commit.
11. If you want to build YouTube with `original icon` and `custom branding icon` both. Add `BUILD_OG_BRANDING_YOUTUBE` 11. If you want to build YouTube with `original icon` and `custom branding icon` both. Add `BUILD_OG_BRANDING_YOUTUBE`
in `.env` file or in `ENVS` in `GitHub secrets` (Recommended) in the format in `.env` file or in `ENVS` in `GitHub secrets` (Recommended) in the format
```dotenv ```dotenv
BUILD_OG_BRANDING_YOUTUBE=True BUILD_OG_BRANDING_YOUTUBE=True
``` ```
You can also specify the branding patch to use for custom icon build. This can be done with by adding You can also specify the branding patch to use for custom icon build. This can be done with by adding
`BRANDING_PATCH` in `ENVS` in `GitHub secrets` (Recommended) in the format `BRANDING_PATCH` in `ENVS` in `GitHub secrets` (Recommended) in the format
```dotenv ```dotenv
BRANDING_PATCH=custom-branding-icon-blue BRANDING_PATCH=custom-branding-icon-blue
``` ```
12. You can build only for a particular arch in order to get smaller apk files.This can be done with by adding comma 12. You can build only for a particular arch in order to get smaller apk files.This can be done with by adding comma
separated `ARCHS_TO_BUILD` in `ENVS` in `GitHub secrets` (Recommended) in the format. separated `ARCHS_TO_BUILD` in `ENVS` in `GitHub secrets` (Recommended) in the format.
```dotenv ```dotenv
@@ -244,30 +252,7 @@ By default, script build the version as recommended by Revanced team.
Possible values for `ARCHS_TO_BUILD` are: `armeabi-v7a`,`x86`,`x86_64`,`arm64-v8a` Possible values for `ARCHS_TO_BUILD` are: `armeabi-v7a`,`x86`,`x86_64`,`arm64-v8a`
Make sure you are using `revanced-extended` as `revanced` doesn't support this. Make sure you are using `revanced-extended` as `revanced` doesn't support this.
13. You can scan your build apks files with VirusTotal. For that, Add `VT_API_KEY` in `GitHub secrets`. 13. You can scan your build apks files with VirusTotal. For that, Add `VT_API_KEY` in `GitHub secrets`.
14. Sample Envs ![envs] 14. Sample Envs<br>
<img src="https://i.imgur.com/ajSE5nA.png" width="600" style="left">
[fork]: https://i.imgur.com/R5HdByI.png
[secrets]: https://i.imgur.com/083Bjpg.png
[step_1]: https://i.imgur.com/Inj82KK.png
[step_2]: https://i.imgur.com/V2Wfx3J.png
[action_0]: https://i.imgur.com/XSCvzav.png
[build_wait]: https://i.imgur.com/CsJt9W1.png
[apks]: https://i.imgur.com/S5d7qAO.png
[chat id]: https://i.imgur.com/22UiaWs.png
[bot api]: https://i.imgur.com/A6JCyK2.png
[tg api]: https://i.imgur.com/eha3nnb.png
[tg api hash]: https://i.imgur.com/7n5k1mp.png
[envs]: https://i.imgur.com/ajSE5nA.png
Thanks to [@aliharslan0](https://github.com/aliharslan0/pyrevanced) for his work. Thanks to [@aliharslan0](https://github.com/aliharslan0/pyrevanced) for his work.