Service: Memos - EyevinnOSC/community GitHub Wiki

Memos

Memos (serviceId usememos-memos) is a lightweight, open source note-taking service with a timeline-style interface, similar to a personal microblog. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT.

What it can do

  • Capture thoughts, links, code snippets and Markdown notes (memos) in a timeline.
  • Store notes privately; tag, search and pin them.
  • Create notes programmatically through the REST API.

Creating an instance

Memos has no dependencies on other OSC services. Create it with create-service-instance, serviceId: "usememos-memos":

{ "name": "mynotes" }

Use wait-for-service-ready or get-instance-status to confirm it is running, then describe-service-instance for the instance URL. With the OSC CLI:

npx -y @osaas/cli create usememos-memos mynotes

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric, at most 20 characters.

There are no other options.

Using the instance

There are no pre-set default credentials. When you first open the instance URL you are redirected to the sign-up page; enter a username and password to create the admin account.

Memos exposes a REST API. After signing in, get an API access token from Settings > My Account > Access Tokens in the Memos UI, then create notes:

curl -X POST https://<your-instance>.auto.prod-se.osaas.io/api/v1/memos \
  -H "Authorization: Bearer <access-token>" \
  -H "Content-Type: application/json" \
  -d '{"content": "Hello from OSC!", "visibility": "PRIVATE"}'

Resources