From a67179d67da4a12f01e2d265be0d7e090a8ebc55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 13:20:47 +0300 Subject: [PATCH 01/11] Create README.md --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1242fdc --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +## Censor Tracker Proxy + +

+ Censor Tracker Proxy +

+ +**Censor Tracker Proxy** is a local SOCKS5 proxy tunnel designed to work with the Censor Tracker browser extension. It allows you to use VLESS, VMess, and Shadowsocks +proxies directly from your browser by forwarding traffic through a local proxy server. + +Key Features: + +- ⚡ Seamless integration with the Censor Tracker extension +- 🌍 Support for multiple proxy protocols (`VLESS`, `VMess`, `Shadowsocks`) +- 🔒 Reliable and efficient browsing experience From 2dd47045b395d2b2ce1778bff17a0eb3df977c6c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 13:22:07 +0300 Subject: [PATCH 02/11] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1242fdc..c264c34 100644 --- a/README.md +++ b/README.md @@ -12,3 +12,4 @@ Key Features: - ⚡ Seamless integration with the Censor Tracker extension - 🌍 Support for multiple proxy protocols (`VLESS`, `VMess`, `Shadowsocks`) - 🔒 Reliable and efficient browsing experience +- 🔗 Local API support, enabling integration with other software and tools From be3ffde4088836f1d4bd8a3d25cd11f60ceb2f3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 13:33:58 +0300 Subject: [PATCH 03/11] Update README.md --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c264c34..d474378 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -## Censor Tracker Proxy +# Censor Tracker Proxy

- Censor Tracker Proxy + Censor Tracker Proxy

**Censor Tracker Proxy** is a local SOCKS5 proxy tunnel designed to work with the Censor Tracker browser extension. It allows you to use VLESS, VMess, and Shadowsocks @@ -13,3 +13,23 @@ Key Features: - 🌍 Support for multiple proxy protocols (`VLESS`, `VMess`, `Shadowsocks`) - 🔒 Reliable and efficient browsing experience - 🔗 Local API support, enabling integration with other software and tools + + +## Installation + +> [!IMPORTANT] +> Censor Tracker Proxy is available only for Windows. + +You can download the latest version for your operating system from the [Releases](https://github.com/censortracker/proxy/releases) page. + + +## Usage + +Once running, the proxy operates as a local `SOCKS5` server and can be configured in the Censor Tracker extension settings. You can also integrate it with external software using the provided API of the local web server. + +## API Documentation + + +## Contributions + +Contributions are welcome! Feel free to fork this repository, submit issues, and open pull requests. From 36f7b6528f2ada5cf4dfde6674e14810737559ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 14:07:05 +0300 Subject: [PATCH 04/11] Update README.md --- README.md | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) diff --git a/README.md b/README.md index d474378..20dada5 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,92 @@ Once running, the proxy operates as a local `SOCKS5` server and can be configure ## API Documentation +#### Retrieve Configs + +**`GET /api/v1/configs`** + +This endpoint retrieves a list of configs. You can request either all configs or specific ones by UUID. + +##### Query Parameters + +- uuid (optional): A comma-separated list of UUIDs. + +##### Response + +- If no UUID is provided – returns all configs. +- If UUIDs are provided – returns only the specified configs. +- If no matching configs are found – returns an empty list. + +#### Add Configs + +**`POST /api/v1/configs`** + +This endpoint adds one or more new configs. Each config is assigned a unique UUID. + +##### Request Body + +An array of serialized config strings, for example: `["vless://…", "vmess://…", "trojan://…"]` + +##### Response + +- 200 OK if the configs are added successfully. +- 400 Bad Request if the data format is invalid. + + +#### Replace Entire Config List + +**`PUT /api/v1/configs`** + +This endpoint completely replaces the current list of configs with a new list. If the currently active config is missing from the new list, the first config in the list becomes active. + +##### Request Body + +A JSON array containing the full list of configs. + +##### Response + +- 200 OK if the list is updated successfully. +- 400 Bad Request if the data format is invalid. + +#### Delete a Config + +**`DELETE /api/v1/configs`** + +This endpoint deletes a config by its UUID. If the active config is deleted, the first remaining config becomes active. + +##### Query Parameters: +- uuid (required): The UUID of the config to delete. + +##### Response + +- 204 No Content if the config is deleted successfully. +- 404 Not Found if the config is not found. + +#### Activate a Config + +**`PUT /api/v1/configs/activate`** + +This endpoint sets the specified config as active by deserializing and preparing it for use. + +##### Query Parameters + +- uuid (required): The UUID of the config to activate. + +##### Response + +- 200 OK if the config is activated successfully. +- 404 Not Found if the config is not found. + +#### Retrieve Active Config + +**`GET /api/v1/configs/active`** + +This endpoint returns the currently active config. + +##### Response +- Returns the active config. +- 404 Not Found if there is no active config. + ## Contributions From 8bcebf4e3c49742a919c41ef64a179bcbd0e6878 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 14:08:58 +0300 Subject: [PATCH 05/11] Update README.md --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 20dada5..afca485 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,12 @@ This endpoint retrieves a list of configs. You can request either all configs or ##### Query Parameters -- uuid (optional): A comma-separated list of UUIDs. +- `uuid` (optional): A comma-separated list of UUIDs. ##### Response -- If no UUID is provided – returns all configs. -- If UUIDs are provided – returns only the specified configs. +- If no `uuid` is provided – returns all configs. +- If `uuid`s are provided – returns only the specified configs. - If no matching configs are found – returns an empty list. #### Add Configs @@ -82,8 +82,9 @@ A JSON array containing the full list of configs. This endpoint deletes a config by its UUID. If the active config is deleted, the first remaining config becomes active. -##### Query Parameters: -- uuid (required): The UUID of the config to delete. +##### Query Parameters + +- `uuid` (required): The UUID of the config to delete. ##### Response @@ -98,7 +99,7 @@ This endpoint sets the specified config as active by deserializing and preparing ##### Query Parameters -- uuid (required): The UUID of the config to activate. +- `uuid` (required): The UUID of the config to activate. ##### Response From f298a05da8ab1360b82a5e18e638c665de6e3712 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 15:21:15 +0300 Subject: [PATCH 06/11] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index afca485..22212d1 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,8 @@ Once running, the proxy operates as a local `SOCKS5` server and can be configure ## API Documentation +See [OpenAPI specification](https://github.com/censortracker/proxy/blob/main/proxyserver/openapi_en.yaml) for more details. + #### Retrieve Configs **`GET /api/v1/configs`** From 71155cdc0d92ed85f62ba7fab4ef484d5ac5a4df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 15:33:10 +0300 Subject: [PATCH 07/11] Update README.md --- README.md | 88 ------------------------------------------------------- 1 file changed, 88 deletions(-) diff --git a/README.md b/README.md index 22212d1..725d4b8 100644 --- a/README.md +++ b/README.md @@ -31,94 +31,6 @@ Once running, the proxy operates as a local `SOCKS5` server and can be configure See [OpenAPI specification](https://github.com/censortracker/proxy/blob/main/proxyserver/openapi_en.yaml) for more details. -#### Retrieve Configs - -**`GET /api/v1/configs`** - -This endpoint retrieves a list of configs. You can request either all configs or specific ones by UUID. - -##### Query Parameters - -- `uuid` (optional): A comma-separated list of UUIDs. - -##### Response - -- If no `uuid` is provided – returns all configs. -- If `uuid`s are provided – returns only the specified configs. -- If no matching configs are found – returns an empty list. - -#### Add Configs - -**`POST /api/v1/configs`** - -This endpoint adds one or more new configs. Each config is assigned a unique UUID. - -##### Request Body - -An array of serialized config strings, for example: `["vless://…", "vmess://…", "trojan://…"]` - -##### Response - -- 200 OK if the configs are added successfully. -- 400 Bad Request if the data format is invalid. - - -#### Replace Entire Config List - -**`PUT /api/v1/configs`** - -This endpoint completely replaces the current list of configs with a new list. If the currently active config is missing from the new list, the first config in the list becomes active. - -##### Request Body - -A JSON array containing the full list of configs. - -##### Response - -- 200 OK if the list is updated successfully. -- 400 Bad Request if the data format is invalid. - -#### Delete a Config - -**`DELETE /api/v1/configs`** - -This endpoint deletes a config by its UUID. If the active config is deleted, the first remaining config becomes active. - -##### Query Parameters - -- `uuid` (required): The UUID of the config to delete. - -##### Response - -- 204 No Content if the config is deleted successfully. -- 404 Not Found if the config is not found. - -#### Activate a Config - -**`PUT /api/v1/configs/activate`** - -This endpoint sets the specified config as active by deserializing and preparing it for use. - -##### Query Parameters - -- `uuid` (required): The UUID of the config to activate. - -##### Response - -- 200 OK if the config is activated successfully. -- 404 Not Found if the config is not found. - -#### Retrieve Active Config - -**`GET /api/v1/configs/active`** - -This endpoint returns the currently active config. - -##### Response -- Returns the active config. -- 404 Not Found if there is no active config. - - ## Contributions Contributions are welcome! Feel free to fork this repository, submit issues, and open pull requests. From e8fdf67a2019336fe2b406f6c14dcae19e7cc0ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 15:42:02 +0300 Subject: [PATCH 08/11] Update README.md --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 725d4b8..ba479f6 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,12 @@ Censor Tracker Proxy

-**Censor Tracker Proxy** is a local SOCKS5 proxy tunnel designed to work with the Censor Tracker browser extension. It allows you to use VLESS, VMess, and Shadowsocks -proxies directly from your browser by forwarding traffic through a local proxy server. +**Censor Tracker Proxy** is a lightweight client that integrates with the Censor Tracker browser extension to enable the use of Xray's proxies +(Vless, Vmess, Shadowsocks, and Trojan) directly from your browser. + +It allows users to add proxy configurations for various protocols and then +sets up a local SOCKS5 proxy server. The browser routes its traffic through this local proxy, which in turn forwards the traffic to the designated remote proxy servers based on your configuration. + Key Features: From e74459aba55e6f7ca8b1c7e9202f1bd0a8eb8c54 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 15:42:38 +0300 Subject: [PATCH 09/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ba479f6..74af705 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ sets up a local SOCKS5 proxy server. The browser routes its traffic through this Key Features: - ⚡ Seamless integration with the Censor Tracker extension -- 🌍 Support for multiple proxy protocols (`VLESS`, `VMess`, `Shadowsocks`) +- 🌍 Support for multiple proxy protocols (`VLESS`, `VMess`, `Shadowsocks` and `Trojan`) - 🔒 Reliable and efficient browsing experience - 🔗 Local API support, enabling integration with other software and tools From 42c1894b51e9ad14a57f7d04896af9d71623916b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 15:43:52 +0300 Subject: [PATCH 10/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 74af705..5e6b5b5 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Key Features: ## Installation > [!IMPORTANT] -> Censor Tracker Proxy is available only for Windows. +> Censor Tracker Proxy is currently available only for Windows. We plan to add support for macOS and Linux in future releases. You can download the latest version for your operating system from the [Releases](https://github.com/censortracker/proxy/releases) page. From 732212343b6c478d8c8581cbb03e87e7a7084061 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Anja=20Grbovi=C4=87?= <160912071+grbovic@users.noreply.github.com> Date: Tue, 18 Feb 2025 15:45:08 +0300 Subject: [PATCH 11/11] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e6b5b5..d19814f 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Censor Tracker Proxy

-**Censor Tracker Proxy** is a lightweight client that integrates with the Censor Tracker browser extension to enable the use of Xray's proxies +**Censor Tracker Proxy** is a lightweight client that integrates with the [Censor Tracker](https://github.com/censortracker) browser extension to enable the use of Xray's proxies (Vless, Vmess, Shadowsocks, and Trojan) directly from your browser. It allows users to add proxy configurations for various protocols and then