Skip to content

Commit

Permalink
Merge branch 'reddit_proxy' into options_saver
Browse files Browse the repository at this point in the history
  • Loading branch information
maxisoft committed Aug 8, 2024
2 parents d42db40 + 8984b36 commit 2b7d29b
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/bump-asf-reference.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/[email protected].6
uses: actions/[email protected].7
with:
token: ${{ env.PUSH_GITHUB_TOKEN }}

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/[email protected].6
uses: actions/[email protected].7
with:
submodules: recursive

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/keepalive.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
name: Keep the repo alive
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected].6
- uses: actions/[email protected].7
timeout-minutes: 5
- uses: gautamkrishnar/keepalive-workflow@v2
timeout-minutes: 5
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/[email protected].6
uses: actions/[email protected].7
with:
submodules: recursive

Expand Down Expand Up @@ -172,13 +172,13 @@ jobs:

steps:
- name: Checkout code
uses: actions/[email protected].6
uses: actions/[email protected].7

# TODO: It'd be perfect if we could match final artifacts to the platform they target, so e.g. linux build comes from the linux machine
# However, that is currently impossible due to https://github.com/dotnet/msbuild/issues/3897
# Therefore, we'll (sadly) pull artifacts from Windows machine only for now
- name: Download generic artifact from windows-latest
uses: actions/[email protected].7
uses: actions/[email protected].8
with:
name: windows-latest_${{ env.PLUGIN_NAME }}-generic
path: out
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test_integration.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ jobs:

steps:
- name: Checkout code
uses: actions/[email protected].6
uses: actions/[email protected].7
timeout-minutes: 5
with:
submodules: recursive
Expand Down
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[submodule "ArchiSteamFarm"]
path = ArchiSteamFarm
url = https://github.com/JustArchiNET/ArchiSteamFarm.git
branch = 6.0.2.6
branch = 6.0.5.2
[submodule "BloomFilter"]
path = BloomFilter
url = https://gist.github.com/8c74d66798a21e05a35b0023573f48e9.git
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,27 @@ The plugin behavior is configurable via command

In addition to the command above, the configuration is stored in a 📖```config/freegames.json.config``` json file, one may 🖊 edit it using a text editor to suit its need.

**Proxy Setup**

The plugin can be configured to use a proxy (HTTP(S), SOCKS4 or SOCKS5) for its HTTP requests to Reddit. You can achieve this in two ways:

1. **Environment Variable:** Set the environment variable `FREEGAMES_RedditProxy` with your desired proxy URL (e.g., `http://yourproxy:port`).
2. **`freegames.json.config`:** Edit the `redditProxy` property within the JSON configuration file located at `<asf>/config/freegames.json.config`. Set the value to your proxy URL.

**Example `freegames.json.config` with Proxy:**

```json
{
...
"redditProxy": "http://127.0.0.1:1080"
}
```

**Important Note:** If you pass a proxy **password**, it will be **stored in clear text** in the `freegames.json.config` file, even when passing it via the environment variable.

**Note:** Whichever method you choose (environment variable or config file), only one will be used at a time.
The environment variable takes precedence over the config file setting.


## FAQ

Expand Down

0 comments on commit 2b7d29b

Please sign in to comment.