Changeset 150 in code for trunk/README.md


Ignore:
Timestamp:
Mar 24, 2024, 12:58:49 AM (15 months ago)
Author:
Izuru Yakumo
Message:

えー

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/README.md

    r149 r150  
    11# Yukari's Gap
    2 
    3 Web content sanitizer proxy as a service, fork of [MortyProxy](https://github.com/asciimoo/morty) with some suggestions from the issue tracker applied, named after [the youkai you shouldn't ever come near](https://en.touhouwiki.net/wiki/Yukari_Yakumo)
     2Web content sanitizer proxy as a service[^1], fork of [MortyProxy](https://github.com/asciimoo/morty) with some suggestions from the issue tracker applied, named after [the youkai you shouldn't ever come near](https://en.touhouwiki.net/wiki/Yukari_Yakumo)
    43
    54Yukari's Gap rewrites web pages to exclude malicious HTML tags and attributes. It also replaces external resource references to prevent third party information leaks.
    … …  
    1817* Optional HMAC URL verifier key to prevent service abuse
    1918
    20 
    2119## Installation and setup
    2220Requirement: Go version 1.16 or higher (thus making it incompatible with MortyProxy's own requirement, but also to use `go embed`)
    … …  
    2624$ "$GOPATH/bin/yukari" --help
    2725```
    28 
    2926### Usage
    3027See `yukari(1)`
    31 
    32 ### Environment variables
    33 
    34 Yukari can additionally be configured using the following environment variables:
    35 - `YUKARI_ADDRESS`: Listen address (default to `127.0.0.1:3000`)
    36 - `YUKARI_KEY`: HMAC url validation key (base64 encoded) to prevent direct URL opening. Leave blank to disable validation. Use `openssl rand -base64 33` to generate.
    37 - `YUKARI_URL_PARAM`: User-defined requesting string URL parameter name (ie: `/?url=...` or `/?u=...`) (default `yukariurl`)
    38 - `YUKARI_HASH_PARAM`: User-defined requesting string HASH parameter name (ie: `/?hash=...` or `/?h=...`) (default `yukarihash`)
    39 - `DEBUG`: Enable/disable proxy and redirection logs (default to `true`). Set to `false` to disable.
    4028
    4129### Test
    4230
    4331```
    44 $ cd "$GOPATH/src/marisa.chaotic.ninja/yukari"
    45 $ go test
     32$ make test
    4633```
    47 
    4834
    4935### Benchmark
    5036
    5137```
    52 $ cd "$GOPATH/src/marisa.chaotic.ninja/yukari"
    53 $ go test -benchmem -bench .
     38$ make bench
    5439```
    55 
    5640
    5741## Bugs
    5842Bugs or suggestions? Mail [yukari-dev@chaotic.ninja](mailto:yukari-dev@chaotic.ninja)
     43
     44---
     45
     46[^1]: or WCPaaS, mind you, also I didn't come up with that, it was already there when I arrived
Note: See TracChangeset for help on using the changeset viewer.