Skip to content

Commit

Permalink
Prepare for merge to upstream
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewL246 committed Jan 5, 2024
1 parent 72dec8b commit 07cdd80
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
2 changes: 0 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ updates:
directory: /
schedule:
interval: daily
assignees:
- MatthewL246
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,12 @@ also delete the NoSSL patch you downloaded in step 2.

### Running with Docker

This is the recommended way to run mitmproxy-pretendo because it always uses the
This is the recommended way to run mitmproxy-nintendo because it always uses the
latest image and is already set up with OpenSSL 1.1.1.

1. Install Docker using the
[official instructions](https://docs.docker.com/get-docker/).
2. Run a new Docker container using the `ghcr.io/matthewl246/mitmproxy-pretendo`
2. Run a new Docker container using the `ghcr.io/pretendonetwork/mitmproxy-nintendo`
image.
- If you're not familiar with Docker, copy the `docker run ...` command from
[this script](./start-docker.sh) to get started. Then, open
Expand All @@ -80,14 +80,14 @@ latest image and is already set up with OpenSSL 1.1.1.
If you want to make modifications to the image, you need to rebuild it locally.

1. Clone this repository to your computer
(`git clone https://github.com/MatthewL246/mitmproxy-pretendo.git`).
(`git clone https://github.com/PretendoNetwork/mitmproxy-nintendo.git`).
2. Use the `./start-docker.sh` script to build and run the container. This build
overwrites the version you downloaded from the container registry. This will
take a few minutes the first time, but it will be cached for future builds.
- You need to rebuild the container every time you change something here.

If you want to revert your local image to the published version, run
`docker pull ghcr.io/matthewl246/mitmproxy-pretendo`.
`docker pull ghcr.io/pretendonetwork/mitmproxy-nintendo`.

### Running locally

Expand All @@ -102,7 +102,7 @@ fail if mitmproxy is using OpenSSL 3.0.0.

1. Install Python 3 and pip.
2. Clone this repository to your computer
(`git clone https://github.com/MatthewL246/mitmproxy-pretendo.git`).
(`git clone https://github.com/PretendoNetwork/mitmproxy-nintendo.git`).
3. Create a virtual environment with `python3 -m venv venv`.
4. Activate the virtual environment with `. ./venv/bin/activate`.
5. Install [mitmproxy](https://mitmproxy.org/) with `pip install mitmproxy`.
Expand Down
4 changes: 2 additions & 2 deletions start-docker.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#! /bin/sh

docker build . -t ghcr.io/matthewl246/mitmproxy-pretendo
docker run -it --rm --name mitmproxy-pretendo -v mitmproxy-pretendo-data:/home/mitmproxy/.mitmproxy -p 8080:8080 -p 127.0.0.1:8081:8081 ghcr.io/matthewl246/mitmproxy-pretendo mitmweb --web-host 0.0.0.0
docker build . -t ghcr.io/pretendonetwork/mitmproxy-nintendo
docker run -it --rm --name mitmproxy-pretendo -v mitmproxy-pretendo-data:/home/mitmproxy/.mitmproxy -p 8080:8080 -p 127.0.0.1:8081:8081 ghcr.io/pretendonetwork/mitmproxy-nintendo mitmweb --web-host 0.0.0.0

0 comments on commit 07cdd80

Please sign in to comment.