Dagger
Search

ngrok

A simple Ngrok module

Installation

dagger install github.com/jpadams/ngrok@705430d08b87aa7d2067c90a5a7e1e64e4069062

Entrypoint

Return Type 
Ngrok
Example
dagger -m github.com/jpadams/ngrok@705430d08b87aa7d2067c90a5a7e1e64e4069062 call \

func (m *myModule) example() *Ngrok  {
	return dag.
			Ngrok()
}
@function
def example() -> dag.Ngrok:
	return (
		dag.ngrok()
	)
@func()
example(): Ngrok {
	return dag
		.ngrok()
}

Types

Ngrok 🔗

share() 🔗

Share a Service via Ngrok

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
serviceService !-No description provided
portInteger !-No description provided
tokenSecret !-No description provided
Example
dagger -m github.com/jpadams/ngrok@705430d08b87aa7d2067c90a5a7e1e64e4069062 call \
 share --service PROTOCOL://HOST:PORT --port integer --token env:MYSECRET
func (m *myModule) example(service *Service, port int, token *Secret) *Container  {
	return dag.
			Ngrok().
			Share(service, port, token)
}
@function
def example(service: dagger.Service, port: int, token: dagger.Secret) -> dagger.Container:
	return (
		dag.ngrok()
		.share(service, port, token)
	)
@func()
example(service: Service, port: number, token: Secret): Container {
	return dag
		.ngrok()
		.share(service, port, token)
}

url() 🔗

Retrieve first Ngrok public url

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiTokenSecret !-No description provided
Example
dagger -m github.com/jpadams/ngrok@705430d08b87aa7d2067c90a5a7e1e64e4069062 call \
 url --api-token env:MYSECRET
func (m *myModule) example(ctx context.Context, apiToken *Secret) string  {
	return dag.
			Ngrok().
			Url(ctx, apiToken)
}
@function
async def example(api_token: dagger.Secret) -> str:
	return await (
		dag.ngrok()
		.url(api_token)
	)
@func()
async example(apiToken: Secret): Promise<string> {
	return dag
		.ngrok()
		.url(apiToken)
}

qr() 🔗

Return first Ngrok public url QR code

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiTokenSecret !-No description provided
Example
dagger -m github.com/jpadams/ngrok@705430d08b87aa7d2067c90a5a7e1e64e4069062 call \
 qr --api-token env:MYSECRET
func (m *myModule) example(ctx context.Context, apiToken *Secret) string  {
	return dag.
			Ngrok().
			Qr(ctx, apiToken)
}
@function
async def example(api_token: dagger.Secret) -> str:
	return await (
		dag.ngrok()
		.qr(api_token)
	)
@func()
async example(apiToken: Secret): Promise<string> {
	return dag
		.ngrok()
		.qr(apiToken)
}

test() 🔗

Test sharing via Ngrok with Nginx

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
portInteger !-No description provided
tokenSecret !-No description provided
Example
dagger -m github.com/jpadams/ngrok@705430d08b87aa7d2067c90a5a7e1e64e4069062 call \
 test --port integer --token env:MYSECRET
func (m *myModule) example(port int, token *Secret) *Container  {
	return dag.
			Ngrok().
			Test(port, token)
}
@function
def example(port: int, token: dagger.Secret) -> dagger.Container:
	return (
		dag.ngrok()
		.test(port, token)
	)
@func()
example(port: number, token: Secret): Container {
	return dag
		.ngrok()
		.test(port, token)
}