https://github.com/eyedeekay/onramp
High-level, easy-to-use listeners and clients for I2P and onion URL's from Go. Provides only the most widely-used functions in a basic way.
https://github.com/eyedeekay/onramp
anonymous garlic hidden-service hidden-services i2p onion peer-to-peer tor
Last synced: about 2 months ago
JSON representation
High-level, easy-to-use listeners and clients for I2P and onion URL's from Go. Provides only the most widely-used functions in a basic way.
- Host: GitHub
- URL: https://github.com/eyedeekay/onramp
- Owner: eyedeekay
- License: mit
- Created: 2022-08-03T19:47:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-23T21:49:30.000Z (4 months ago)
- Last Synced: 2025-04-19T03:34:21.512Z (about 2 months ago)
- Topics: anonymous, garlic, hidden-service, hidden-services, i2p, onion, peer-to-peer, tor
- Language: Go
- Homepage: https://eyedeekay.github.io/onramp
- Size: 176 KB
- Stars: 11
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
onramp
======
[](https://goreportcard.com/report/github.com/go-i2p/onramp)
High-level, easy-to-use listeners and clients for I2P and onion URL's from Go.
Provides only the most widely-used functions in a basic way. It expects nothing
from the users, an otherwise empty instance of the structs will listen and dial
I2P Streaming and Tor TCP sessions successfully.
In all cases, it assumes that keys are "persistent" in that they are managed
maintained between usages of the same application in the same configuration.
This means that hidden services will maintain their identities, and that clients
will always have the same return addresses. If you don't want this behavior,
make sure to delete the "keystore" when your app closes or when your application
needs to cycle keys by calling the `Garlic.DeleteKeys()` or `Onion.DeleteKeys()`
function. For more information, check out the [godoc](http://pkg.go.dev/github.com/go-i2p/onramp).
- **[Source Code](https://github.com/go-i2p/onramp)**
STATUS: This project is maintained. I will respond to issues, pull requests, and feature requests within a few days.
Usage
-----
Basic usage is designed to be very simple, import the package and instantiate
a struct and you're ready to go.
For more extensive examples, see: [EXAMPLE](EXAMPLE.md)
### I2P(Garlic) Usage:
When using it to manage an I2P session, set up an `onramp.Garlic`
struct.
```Go
package main
import (
"log"
"github.com/go-i2p/onramp"
)
func main() {
garlic := &onramp.Garlic{}
defer garlic.Close()
listener, err := garlic.Listen()
if err != nil {
log.Fatal(err)
}
defer listener.Close()
}
```
### Tor(Onion) Usage:
When using it to manage a Tor session, set up an `onramp.Onion`
struct.
```Go
package main
import (
"log"
"github.com/go-i2p/onramp"
)
func main() {
onion := &onramp.Onion{}
defer garlic.Close()
listener, err := onion.Listen()
if err != nil {
log.Fatal(err)
}
defer listener.Close()
}
```
## Verbosity ##
Logging can be enabled and configured using the DEBUG_I2P environment variable. By default, logging is disabled.
There are three available log levels:
- Debug
```shell
export DEBUG_I2P=debug
```
- Warn
```shell
export DEBUG_I2P=warn
```
- Error
```shell
export DEBUG_I2P=error
```
If DEBUG_I2P is set to an unrecognized variable, it will fall back to "debug".
## Contributing
See CONTRIBUTING.md for more information.
## License
This project is licensed under the MIT license, see LICENSE for more information.