mirror of
https://github.com/go-i2p/go-i2pbrowser.git
synced 2025-06-17 06:35:40 -04:00
225 lines
6.1 KiB
HTML
225 lines
6.1 KiB
HTML
<html>
|
|
<head>
|
|
<title>
|
|
goi2pbrowser
|
|
</title>
|
|
<meta name="author" content="eyedeekay" />
|
|
<meta name="description" content="go-i2pbrowser" />
|
|
<meta name="keywords" content="trunk" />
|
|
<link rel="stylesheet" type="text/css" href="style.css" />
|
|
<link rel="stylesheet" type="text/css" href="showhider.css" />
|
|
</head>
|
|
<body>
|
|
<div id="navbar">
|
|
<a href="#shownav">
|
|
Show navigation
|
|
</a>
|
|
<div id="shownav">
|
|
<div id="hidenav">
|
|
<ul>
|
|
<li>
|
|
<a href="..">
|
|
Up one level ^
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="index.html">
|
|
index
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="LICENSE.html">
|
|
LICENSE
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="index.html">
|
|
index.html
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<br>
|
|
<a href="#hidenav">
|
|
Hide Navigation
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a id="returnhome" href="/">
|
|
/
|
|
</a>
|
|
<h1>
|
|
goi2pbrowser
|
|
</h1>
|
|
<p>
|
|
Package goi2pbrowser is a package which can be used to manage an I2P browsing
|
|
profile using a pre-configured, common profile which is used by the I2P Easy-Install
|
|
bundle and the i2p.plugins.firefox profile manager. It is a Go clone of
|
|
i2p.plugins.firefox for use in native applications.
|
|
</p>
|
|
<h2>
|
|
Variables
|
|
</h2>
|
|
<p>
|
|
BaseProfile is a zip of a Firefox profile with NoScript, HTTPS Everywhere, and I2PIPB
|
|
</p>
|
|
<pre><code class="language-golang">var BaseProfile []byte
|
|
</code></pre>
|
|
<p>
|
|
UsabilityProfile is a zip of a Firefox profile with Jshelter, HTTPS Everywhere, uBlock Origin, LocalCDN, OICT, and I2PIPB
|
|
</p>
|
|
<pre><code class="language-golang">var UsabilityProfile []byte
|
|
</code></pre>
|
|
<h2>
|
|
Functions
|
|
</h2>
|
|
<h3>
|
|
func
|
|
<a href="/run.go#L53">
|
|
BrowseApp
|
|
</a>
|
|
</h3>
|
|
<p>
|
|
<code>
|
|
func BrowseApp(profileDir string, url ...string)
|
|
</code>
|
|
</p>
|
|
<p>
|
|
BrowseApp launches a Firefox browser configured to use I2P and waits for it to exit.
|
|
The profile is in “Usability” mode
|
|
</p>
|
|
<h3>
|
|
func
|
|
<a href="/run.go#L15">
|
|
BrowseStrict
|
|
</a>
|
|
</h3>
|
|
<p>
|
|
<code>
|
|
func BrowseStrict(profileDir string, url ...string)
|
|
</code>
|
|
</p>
|
|
<p>
|
|
BrowseStrict launches a Firefox browser configured to use I2P and waits for it to exit.
|
|
The profile is in “Strict” mode
|
|
</p>
|
|
<h3>
|
|
func
|
|
<a href="/run.go#L34">
|
|
BrowseUsability
|
|
</a>
|
|
</h3>
|
|
<p>
|
|
<code>
|
|
func BrowseUsability(profileDir string, url ...string)
|
|
</code>
|
|
</p>
|
|
<p>
|
|
BrowseUsability launches a Firefox browser configured to use I2P and waits for it to exit.
|
|
The profile is in “Usability” mode
|
|
</p>
|
|
<h3>
|
|
func
|
|
<a href="/unembed.go#L22">
|
|
UnpackBase
|
|
</a>
|
|
</h3>
|
|
<p>
|
|
<code>
|
|
func UnpackBase(profileDir string) (string, error)
|
|
</code>
|
|
</p>
|
|
<p>
|
|
UnpackBase unpacks a “Strict” mode profile into the “profileDir” and returns the
|
|
path to the profile and possibly, an error if something goes wrong. If everything
|
|
works, the error will be nil
|
|
</p>
|
|
<h3>
|
|
func
|
|
<a href="/unembed.go#L41">
|
|
UnpackUsability
|
|
</a>
|
|
</h3>
|
|
<p>
|
|
<code>
|
|
func UnpackUsability(profileDir string) (string, error)
|
|
</code>
|
|
</p>
|
|
<p>
|
|
UnpackUsability unpacks a “Usability” mode profile into the “profileDir” and returns the
|
|
path to the profile and possibly, an error if something goes wrong. If everything
|
|
works, the error will be nil
|
|
</p>
|
|
<h2>
|
|
Sub Packages
|
|
</h2>
|
|
<ul>
|
|
<li>
|
|
<a href="./i2pbrowser">
|
|
i2pbrowser
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
<hr />
|
|
<p>
|
|
Readme created from Go doc with
|
|
<a href="https://github.com/posener/goreadme">
|
|
goreadme
|
|
</a>
|
|
</p>
|
|
<div id="sourcecode">
|
|
<span id="sourcehead">
|
|
<strong>
|
|
Get the source code:
|
|
</strong>
|
|
</span>
|
|
<ul>
|
|
<li>
|
|
<a href="https://github.com/eyedeekay/go-i2pbrowser.git">
|
|
Source Repository: (https://github.com/eyedeekay/go-i2pbrowser.git)
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div>
|
|
<a href="#show">
|
|
Show license
|
|
</a>
|
|
<div id="show">
|
|
<div id="hide">
|
|
<pre><code>Copyright 2022
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
this software and associated documentation files (the "Software"), to deal in
|
|
the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
</code></pre>
|
|
<a href="#hide">
|
|
Hide license
|
|
</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<iframe src="https://snowflake.torproject.org/embed.html" width="320" height="240" frameborder="0" scrolling="no"></iframe>
|
|
</div>
|
|
<div>
|
|
<a href="https://geti2p.net/">
|
|
<img src="i2plogo.png"></img>
|
|
I2P
|
|
</a>
|
|
</div>
|
|
</body>
|
|
</html> |