home

command module
Version: v0.0.0-...-751c7a0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 25, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

README

M3O Home

The home for apps, functions and more

Overview

The M3O Home app is a single entrypoint for apps, functions and more hosted on the M3O platform. It acts as a launcher for other apps and functions that are UI based.

Supported features:

Apps

Apps are given a unique id and subdomain using m3o.app e.g helloworld.m3o.app resolves to the app id helloworld.

The /v1/app/Resolve endpoint is called with the ID specified to resolve the backend URL for the app

Functions

Functions are given a unique id and subdomain much like apps using m3o.sh e.g helloworld.m3o.sh resolves to the function helloworld.

The /v1/function/Proxy endpoint is called with the ID specified to resolve the backend URL for the function

URL Generator

The URL service provides link generation and sharing.

  • Assumes url is of format /url/AArfeZE
  • Will call https://api.m3o.com/url/resolve?id=AArfeZE
  • URL service should return destinationURL=https://foobar.com/example
  • The ingress URL proxy handler will issue a 302 redirect

User Verification

User email verification is performed via the /v1/user/VerifyEmail endpoint. The ingress serves user.m3o.com for this purpose.

This is also available via the /user/[id] endpoint

Usage

Specify M3O_API_TOKEN to the binary and run the ingress

Micro Services

Set the config values

micro config set micro.app.domain m3o.app
micro config set micro.app.domain m3o.sh
micro config set micro.url.host_prefix https://m3o.one/u/
micro config set micro.user.verify_email_url https://user.m3o.com

Deploy the url, function, app, user services

micro run github.com/micro/services/app
micro run github.com/micro/services/function
micro run github.com/micro/services/url
micro run github.com/micro/services/user

Documentation

The Go Gopher

There is no documentation for this package.

Source Files

Directories

Path Synopsis
api
Package api provides the API building blocks for distributed
Package api provides the API building blocks for distributed
job
web
Package web includes the web frontend
Package web includes the web frontend
govanityurls serves Go vanity URLs.
govanityurls serves Go vanity URLs.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL