Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
.env",id:"example-env",level:2}];function h(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(t.header,{children:(0,d.jsx)(t.h1,{id:"configuration",children:"Configuration"})}),"\n",(0,d.jsxs)(t.p,{children:["HappyView is configured via environment variables. A ",(0,d.jsx)(t.code,{children:".env"})," file in the project root is loaded automatically on startup. See ",(0,d.jsx)(t.a,{href:"/getting-started/deployment/docker",children:"Deployment"})," for local setup or ",(0,d.jsx)(t.a,{href:"/reference/production-deployment",children:"Production Deployment"})," for production setup."]}),"\n",(0,d.jsx)(t.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,d.jsxs)(t.table,{children:[(0,d.jsx)(t.thead,{children:(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.th,{children:"Variable"}),(0,d.jsx)(t.th,{children:"Required"}),(0,d.jsx)(t.th,{children:"Default"}),(0,d.jsx)(t.th,{children:"Description"})]})}),(0,d.jsxs)(t.tbody,{children:[(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"DATABASE_URL"})}),(0,d.jsx)(t.td,{children:"yes"}),(0,d.jsx)(t.td,{children:"---"}),(0,d.jsx)(t.td,{children:"Postgres connection string"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"AIP_URL"})}),(0,d.jsx)(t.td,{children:"yes"}),(0,d.jsx)(t.td,{children:"---"}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.a,{href:"https://github.com/graze-social/aip",children:"AIP"})," instance URL for OAuth token validation"]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"HOST"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"0.0.0.0"})}),(0,d.jsx)(t.td,{children:"Bind host"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"PORT"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"3000"})}),(0,d.jsx)(t.td,{children:"Bind port"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TAP_URL"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"http://localhost:2480"})}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.a,{href:"https://github.com/bluesky-social/indigo/tree/main/cmd/tap",children:"Tap"})," instance URL for real-time record streaming and backfill"]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"TAP_ADMIN_PASSWORD"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:"---"}),(0,d.jsx)(t.td,{children:"Shared secret for authenticating with Tap's admin endpoints"})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"RELAY_URL"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"https://bsky.network"})}),(0,d.jsxs)(t.td,{children:["Relay URL for ",(0,d.jsx)(t.a,{href:"/guides/backfill",children:"backfill"})," repo discovery"]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"PLC_URL"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"https://plc.directory"})}),(0,d.jsxs)(t.td,{children:[(0,d.jsx)(t.a,{href:"https://github.com/did-method-plc/did-method-plc",children:"PLC directory"})," URL for DID resolution"]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"EVENT_LOG_RETENTION_DAYS"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"30"})}),(0,d.jsxs)(t.td,{children:["Number of days to keep event logs before automatic cleanup. Set to ",(0,d.jsx)(t.code,{children:"0"})," to disable cleanup"]})]}),(0,d.jsxs)(t.tr,{children:[(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"RUST_LOG"})}),(0,d.jsx)(t.td,{children:"no"}),(0,d.jsx)(t.td,{children:(0,d.jsx)(t.code,{children:"happyview=debug,tower_http=debug"})}),(0,d.jsxs)(t.td,{children:["Log filter (uses ",(0,d.jsx)(t.code,{children:"tracing_subscriber::EnvFilter"}),")"]})]})]})]}),"\n",(0,d.jsxs)(t.h2,{id:"example-env",children:["Example ",(0,d.jsx)(t.code,{children:".env"})]}),"\n",(0,d.jsx)(t.pre,{children:(0,d.jsx)(t.code,{className:"language-sh",children:"DATABASE_URL=postgres://happyview:happyview@localhost/happyview\nAIP_URL=http://localhost:8080\n\n# Optional overrides\n# HOST=0.0.0.0\n# PORT=3000\n# TAP_URL=http://localhost:2480\n# TAP_ADMIN_PASSWORD=your-secret-here\n# RELAY_URL=https://bsky.network\n# PLC_URL=https://plc.directory\n# EVENT_LOG_RETENTION_DAYS=30\n# RUST_LOG=happyview=debug,tower_http=debug\n"})})]})}function a(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,d.jsx)(t,{...e,children:(0,d.jsx)(h,{...e})}):h(e)}},8453(e,t,n){n.d(t,{R:()=>s,x:()=>c});var r=n(6540);const d={},i=r.createContext(d);function s(e){const t=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:s(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/009f1e98.79c081e2.js b/assets/js/009f1e98.79c081e2.js
new file mode 100644
index 0000000..acd723a
--- /dev/null
+++ b/assets/js/009f1e98.79c081e2.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_happyview_docs=self.webpackChunk_happyview_docs||[]).push([[7715],{1823:(e,t,n)=>{n.r(t),n.d(t,{assets:()=>o,contentTitle:()=>c,default:()=>a,frontMatter:()=>i,metadata:()=>d,toc:()=>l});const d=JSON.parse('{"id":"getting-started/configuration","title":"Configuration","description":"HappyView is configured via environment variables. A .env file in the project root is loaded automatically on startup. See Deployment for local setup or Production Deployment for production setup.","source":"@site/docs/getting-started/configuration.md","sourceDirName":"getting-started","slug":"/getting-started/configuration","permalink":"/getting-started/configuration","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"Production","permalink":"/reference/production-deployment"},"next":{"title":"Authentication","permalink":"/getting-started/authentication"}}');var r=n(199),s=n(2560);const i={},c="Configuration",o={},l=[{value:"Environment variables",id:"environment-variables",level:2},{value:"Example .env",id:"example-env",level:2},{value:"Next steps",id:"next-steps",level:2}];function h(e){const t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"configuration",children:"Configuration"})}),"\n",(0,r.jsxs)(t.p,{children:["HappyView is configured via environment variables. A ",(0,r.jsx)(t.code,{children:".env"})," file in the project root is loaded automatically on startup. See ",(0,r.jsx)(t.a,{href:"/getting-started/deployment/docker",children:"Deployment"})," for local setup or ",(0,r.jsx)(t.a,{href:"/reference/production-deployment",children:"Production Deployment"})," for production setup."]}),"\n",(0,r.jsx)(t.h2,{id:"environment-variables",children:"Environment variables"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Variable"}),(0,r.jsx)(t.th,{children:"Required"}),(0,r.jsx)(t.th,{children:"Default"}),(0,r.jsx)(t.th,{children:"Description"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"DATABASE_URL"})}),(0,r.jsx)(t.td,{children:"yes"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsxs)(t.td,{children:["Database connection string. SQLite (",(0,r.jsx)(t.code,{children:"sqlite://path/to/db?mode=rwc"}),") or Postgres (",(0,r.jsx)(t.code,{children:"postgres://user:pass@host/db"}),")"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"DATABASE_BACKEND"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"auto-detected"}),(0,r.jsxs)(t.td,{children:["Force ",(0,r.jsx)(t.code,{children:"sqlite"})," or ",(0,r.jsx)(t.code,{children:"postgres"}),". Auto-detected from ",(0,r.jsx)(t.code,{children:"DATABASE_URL"})," scheme if not set"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"PUBLIC_URL"})}),(0,r.jsx)(t.td,{children:"yes"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsxs)(t.td,{children:["Public-facing URL for HappyView (used for OAuth callbacks, e.g. ",(0,r.jsx)(t.code,{children:"https://happyview.example.com"}),")"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"SESSION_SECRET"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"dev default"}),(0,r.jsxs)(t.td,{children:["Secret key for signing session cookies (at least 64 characters). ",(0,r.jsx)(t.strong,{children:"Must be set in production"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"HOST"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"0.0.0.0"})}),(0,r.jsx)(t.td,{children:"Bind host"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"PORT"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"3000"})}),(0,r.jsx)(t.td,{children:"Bind port"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"JETSTREAM_URL"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"wss://jetstream1.us-east.bsky.network"})}),(0,r.jsx)(t.td,{children:"Jetstream WebSocket URL for real-time record streaming"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"RELAY_URL"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"https://bsky.network"})}),(0,r.jsxs)(t.td,{children:["Relay URL for ",(0,r.jsx)(t.a,{href:"/guides/backfill",children:"backfill"})," repo discovery"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"PLC_URL"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"https://plc.directory"})}),(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.a,{href:"https://github.com/did-method-plc/did-method-plc",children:"PLC directory"})," URL for DID resolution"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"STATIC_DIR"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"./web/out"})}),(0,r.jsx)(t.td,{children:"Directory containing the built dashboard static assets"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"EVENT_LOG_RETENTION_DAYS"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"30"})}),(0,r.jsxs)(t.td,{children:["Number of days to keep event logs before automatic cleanup. Set to ",(0,r.jsx)(t.code,{children:"0"})," to disable cleanup"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"TOKEN_ENCRYPTION_KEY"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsxs)(t.td,{children:["Base64-encoded 32-byte key for encrypting stored OAuth tokens. ",(0,r.jsx)(t.strong,{children:"Strongly recommended in production"})]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"DEFAULT_RATE_LIMIT_CAPACITY"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"100"})}),(0,r.jsx)(t.td,{children:"Default token bucket capacity used when registering a new API client"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"DEFAULT_RATE_LIMIT_REFILL_RATE"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"2.0"})}),(0,r.jsx)(t.td,{children:"Default token bucket refill rate (tokens/second) for new API clients"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"RUST_LOG"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"happyview=debug,tower_http=debug"})}),(0,r.jsxs)(t.td,{children:["Log filter (uses ",(0,r.jsx)(t.code,{children:"tracing_subscriber::EnvFilter"}),")"]})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"APP_NAME"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsx)(t.td,{children:"Application name shown on OAuth authorization screens. Overridden by database setting if set via admin API"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"LOGO_URI"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsx)(t.td,{children:"URL to application logo for OAuth screens. Overridden by database setting or logo upload"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"TOS_URI"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsx)(t.td,{children:"URL to terms of service. Overridden by database setting if set via admin API"})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"POLICY_URI"})}),(0,r.jsx)(t.td,{children:"no"}),(0,r.jsx)(t.td,{children:"---"}),(0,r.jsx)(t.td,{children:"URL to privacy policy. Overridden by database setting if set via admin API"})]})]})]}),"\n",(0,r.jsxs)(t.h2,{id:"example-env",children:["Example ",(0,r.jsx)(t.code,{children:".env"})]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-sh",children:"# SQLite (default \u2014 zero setup required)\nDATABASE_URL=sqlite://data/happyview.db?mode=rwc\nPUBLIC_URL=http://localhost:3000\nSESSION_SECRET=change-me-in-production\n\n# Or use Postgres instead:\n# DATABASE_URL=postgres://happyview:happyview@localhost/happyview\n\n# Optional overrides\n# HOST=0.0.0.0\n# PORT=3000\n# JETSTREAM_URL=wss://jetstream1.us-east.bsky.network\n# RELAY_URL=https://bsky.network\n# PLC_URL=https://plc.directory\n# STATIC_DIR=./web/out\n# EVENT_LOG_RETENTION_DAYS=30\n# TOKEN_ENCRYPTION_KEY=base64-encoded-32-byte-key\n# DEFAULT_RATE_LIMIT_CAPACITY=100\n# DEFAULT_RATE_LIMIT_REFILL_RATE=2.0\n# RUST_LOG=happyview=debug,tower_http=debug\n# APP_NAME=My App\n# LOGO_URI=https://example.com/logo.png\n# TOS_URI=https://example.com/tos\n# POLICY_URI=https://example.com/privacy\n"})}),"\n",(0,r.jsx)(t.h2,{id:"next-steps",children:"Next steps"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.a,{href:"/getting-started/authentication",children:"Authentication"})," \u2014 set up OAuth and admin users"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.a,{href:"/getting-started/dashboard",children:"Dashboard"})," \u2014 explore the admin dashboard"]}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.a,{href:"/reference/production-deployment",children:"Production deployment"})," \u2014 deploy HappyView to production"]}),"\n"]})]})}function a(e={}){const{wrapper:t}={...(0,s.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},2560:(e,t,n)=>{n.d(t,{R:()=>i,x:()=>c});var d=n(63);const r={},s=d.createContext(r);function i(e){const t=d.useContext(s);return d.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function c(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:i(e.components),d.createElement(s.Provider,{value:t},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/0510ba17.e5e327f0.js b/assets/js/0510ba17.e5e327f0.js
new file mode 100644
index 0000000..4856da0
--- /dev/null
+++ b/assets/js/0510ba17.e5e327f0.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_happyview_docs=self.webpackChunk_happyview_docs||[]).push([[3334],{8626:(e,s,r)=>{r.r(s),r.d(s,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>n,toc:()=>a});const n=JSON.parse('{"id":"reference/admin/users","title":"Admin API: Users","description":"Manage admin users and their permissions. See the Permissions guide for available permissions and templates.","source":"@site/docs/reference/admin/users.md","sourceDirName":"reference/admin","slug":"/reference/admin/users","permalink":"/reference/admin/users","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"API Keys","permalink":"/reference/admin/api-keys"},"next":{"title":"Labelers","permalink":"/reference/admin/labelers"}}');var d=r(199),i=r(2560);const t={},c="Admin API: Users",l={},a=[{value:"Create a user",id:"create-a-user",level:2},{value:"List users",id:"list-users",level:2},{value:"Get a user",id:"get-a-user",level:2},{value:"Update user permissions",id:"update-user-permissions",level:2},{value:"Transfer super user",id:"transfer-super-user",level:2},{value:"Delete a user",id:"delete-a-user",level:2}];function o(e){const s={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)(s.header,{children:(0,d.jsx)(s.h1,{id:"admin-api-users",children:"Admin API: Users"})}),"\n",(0,d.jsxs)(s.p,{children:["Manage admin users and their permissions. See the ",(0,d.jsx)(s.a,{href:"/guides/permissions",children:"Permissions guide"})," for available permissions and templates."]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'# All examples assume $TOKEN is an API key (hv_...)\nAUTH="Authorization: Bearer $TOKEN"\n'})}),"\n",(0,d.jsx)(s.h2,{id:"create-a-user",children:"Create a user"}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{children:"POST /admin/users\n"})}),"\n",(0,d.jsxs)(s.p,{children:["Requires ",(0,d.jsx)(s.code,{children:"users:create"})," permission. You cannot grant permissions you don't have yourself (escalation guard)."]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'curl -X POST http://localhost:3000/admin/users \\\n -H "$AUTH" \\\n -H "Content-Type: application/json" \\\n -d \'{\n "did": "did:plc:newuser",\n "template": "operator"\n }\'\n'})}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Field"}),(0,d.jsx)(s.th,{children:"Type"}),(0,d.jsx)(s.th,{children:"Required"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"did"})}),(0,d.jsx)(s.td,{children:"string"}),(0,d.jsx)(s.td,{children:"yes"}),(0,d.jsx)(s.td,{children:"The atproto DID of the user to add"})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"template"})}),(0,d.jsx)(s.td,{children:"string"}),(0,d.jsx)(s.td,{children:"no"}),(0,d.jsxs)(s.td,{children:["Permission template: ",(0,d.jsx)(s.code,{children:"viewer"}),", ",(0,d.jsx)(s.code,{children:"operator"}),", ",(0,d.jsx)(s.code,{children:"manager"}),", or ",(0,d.jsx)(s.code,{children:"full_access"})]})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"permissions"})}),(0,d.jsx)(s.td,{children:"string[]"}),(0,d.jsx)(s.td,{children:"no"}),(0,d.jsxs)(s.td,{children:["Explicit list of permissions to grant (used instead of or in addition to ",(0,d.jsx)(s.code,{children:"template"}),")"]})]})]})]}),"\n",(0,d.jsxs)(s.p,{children:["If neither ",(0,d.jsx)(s.code,{children:"template"})," nor ",(0,d.jsx)(s.code,{children:"permissions"})," is provided, the user is created with no permissions."]}),"\n",(0,d.jsxs)(s.p,{children:[(0,d.jsx)(s.strong,{children:"Response"}),": ",(0,d.jsx)(s.code,{children:"201 Created"})]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-json",children:'{\n "id": "550e8400-e29b-41d4-a716-446655440000",\n "did": "did:plc:newuser",\n "is_super": false,\n "permissions": ["lexicons:read", "records:read", "script-variables:read", "users:read", "api-keys:read", "api-keys:create", "api-keys:delete", "backfill:read", "backfill:create", "stats:read", "events:read"]\n}\n'})}),"\n",(0,d.jsx)(s.h2,{id:"list-users",children:"List users"}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{children:"GET /admin/users\n"})}),"\n",(0,d.jsxs)(s.p,{children:["Requires ",(0,d.jsx)(s.code,{children:"users:read"})," permission."]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'curl http://localhost:3000/admin/users -H "$AUTH"\n'})}),"\n",(0,d.jsxs)(s.p,{children:[(0,d.jsx)(s.strong,{children:"Response"}),": ",(0,d.jsx)(s.code,{children:"200 OK"})]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-json",children:'[\n {\n "id": "550e8400-e29b-41d4-a716-446655440000",\n "did": "did:plc:admin",\n "is_super": true,\n "permissions": ["lexicons:create", "lexicons:read", "lexicons:delete", "records:read", "records:delete", "records:delete-collection", "script-variables:create", "script-variables:read", "script-variables:delete", "users:create", "users:read", "users:update", "users:delete", "api-keys:create", "api-keys:read", "api-keys:delete", "backfill:create", "backfill:read", "stats:read", "events:read"],\n "created_at": "2025-01-01T00:00:00Z",\n "last_used_at": "2025-01-02T12:00:00Z"\n }\n]\n'})}),"\n",(0,d.jsx)(s.h2,{id:"get-a-user",children:"Get a user"}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{children:"GET /admin/users/{id}\n"})}),"\n",(0,d.jsxs)(s.p,{children:["Requires ",(0,d.jsx)(s.code,{children:"users:read"})," permission."]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'curl http://localhost:3000/admin/users/550e8400-e29b-41d4-a716-446655440000 -H "$AUTH"\n'})}),"\n",(0,d.jsxs)(s.p,{children:[(0,d.jsx)(s.strong,{children:"Response"}),": ",(0,d.jsx)(s.code,{children:"200 OK"})," with the same shape as a single item from the list response."]}),"\n",(0,d.jsx)(s.h2,{id:"update-user-permissions",children:"Update user permissions"}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{children:"PATCH /admin/users/{id}/permissions\n"})}),"\n",(0,d.jsxs)(s.p,{children:["Requires ",(0,d.jsx)(s.code,{children:"users:update"})," permission. You cannot grant permissions you don't have yourself, and you cannot modify the super user's permissions."]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'curl -X PATCH http://localhost:3000/admin/users/550e8400-e29b-41d4-a716-446655440000/permissions \\\n -H "$AUTH" \\\n -H "Content-Type: application/json" \\\n -d \'{\n "grant": ["lexicons:create", "lexicons:delete"],\n "revoke": ["records:delete"]\n }\'\n'})}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Field"}),(0,d.jsx)(s.th,{children:"Type"}),(0,d.jsx)(s.th,{children:"Required"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsxs)(s.tbody,{children:[(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"grant"})}),(0,d.jsx)(s.td,{children:"string[]"}),(0,d.jsx)(s.td,{children:"no"}),(0,d.jsx)(s.td,{children:"Permissions to add"})]}),(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"revoke"})}),(0,d.jsx)(s.td,{children:"string[]"}),(0,d.jsx)(s.td,{children:"no"}),(0,d.jsx)(s.td,{children:"Permissions to remove"})]})]})]}),"\n",(0,d.jsxs)(s.p,{children:[(0,d.jsx)(s.strong,{children:"Response"}),": ",(0,d.jsx)(s.code,{children:"200 OK"})," with the updated user object."]}),"\n",(0,d.jsx)(s.h2,{id:"transfer-super-user",children:"Transfer super user"}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{children:"POST /admin/users/transfer-super\n"})}),"\n",(0,d.jsx)(s.p,{children:"Only the current super user can call this endpoint. Transfers super user status to another existing user."}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'curl -X POST http://localhost:3000/admin/users/transfer-super \\\n -H "$AUTH" \\\n -H "Content-Type: application/json" \\\n -d \'{ "target_user_id": "550e8400-e29b-41d4-a716-446655440000" }\'\n'})}),"\n",(0,d.jsxs)(s.table,{children:[(0,d.jsx)(s.thead,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.th,{children:"Field"}),(0,d.jsx)(s.th,{children:"Type"}),(0,d.jsx)(s.th,{children:"Required"}),(0,d.jsx)(s.th,{children:"Description"})]})}),(0,d.jsx)(s.tbody,{children:(0,d.jsxs)(s.tr,{children:[(0,d.jsx)(s.td,{children:(0,d.jsx)(s.code,{children:"target_user_id"})}),(0,d.jsx)(s.td,{children:"string"}),(0,d.jsx)(s.td,{children:"yes"}),(0,d.jsx)(s.td,{children:"The ID of the user to receive super status"})]})})]}),"\n",(0,d.jsxs)(s.p,{children:[(0,d.jsx)(s.strong,{children:"Response"}),": ",(0,d.jsx)(s.code,{children:"200 OK"})]}),"\n",(0,d.jsx)(s.h2,{id:"delete-a-user",children:"Delete a user"}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{children:"DELETE /admin/users/{id}\n"})}),"\n",(0,d.jsxs)(s.p,{children:["Requires ",(0,d.jsx)(s.code,{children:"users:delete"})," permission. You cannot delete the super user or yourself."]}),"\n",(0,d.jsx)(s.pre,{children:(0,d.jsx)(s.code,{className:"language-sh",children:'curl -X DELETE http://localhost:3000/admin/users/550e8400-e29b-41d4-a716-446655440000 \\\n -H "$AUTH"\n'})}),"\n",(0,d.jsxs)(s.p,{children:[(0,d.jsx)(s.strong,{children:"Response"}),": ",(0,d.jsx)(s.code,{children:"204 No Content"})]})]})}function h(e={}){const{wrapper:s}={...(0,i.R)(),...e.components};return s?(0,d.jsx)(s,{...e,children:(0,d.jsx)(o,{...e})}):o(e)}},2560:(e,s,r)=>{r.d(s,{R:()=>t,x:()=>c});var n=r(63);const d={},i=n.createContext(d);function t(e){const s=n.useContext(i);return n.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function c(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:t(e.components),n.createElement(i.Provider,{value:s},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/09c1314d.df6dc576.js b/assets/js/09c1314d.df6dc576.js
new file mode 100644
index 0000000..a60c07a
--- /dev/null
+++ b/assets/js/09c1314d.df6dc576.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_happyview_docs=self.webpackChunk_happyview_docs||[]).push([[6590],{2959:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>h,frontMatter:()=>t,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"reference/admin/lexicons","title":"Admin API: Lexicons","description":"Manage lexicons and network lexicons. See the Lexicons guide for background on how lexicons drive indexing and XRPC routing.","source":"@site/docs/reference/admin/lexicons.md","sourceDirName":"reference/admin","slug":"/reference/admin/lexicons","permalink":"/reference/admin/lexicons","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"Overview","permalink":"/reference/admin-api"},"next":{"title":"Stats","permalink":"/reference/admin/stats"}}');var r=s(199),c=s(2560);const t={},d="Admin API: Lexicons",l={},o=[{value:"Upload / upsert a lexicon",id:"upload--upsert-a-lexicon",level:2},{value:"List lexicons",id:"list-lexicons",level:2},{value:"Get a lexicon",id:"get-a-lexicon",level:2},{value:"Delete a lexicon",id:"delete-a-lexicon",level:2},{value:"Network Lexicons",id:"network-lexicons",level:2},{value:"Add a network lexicon",id:"add-a-network-lexicon",level:3},{value:"List network lexicons",id:"list-network-lexicons",level:3},{value:"Remove a network lexicon",id:"remove-a-network-lexicon",level:3}];function a(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"admin-api-lexicons",children:"Admin API: Lexicons"})}),"\n",(0,r.jsxs)(n.p,{children:["Manage lexicons and network lexicons. See the ",(0,r.jsx)(n.a,{href:"/guides/lexicons",children:"Lexicons guide"})," for background on how lexicons drive indexing and XRPC routing."]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'# All examples assume $TOKEN is an API key (hv_...)\nAUTH="Authorization: Bearer $TOKEN"\n'})}),"\n",(0,r.jsx)(n.h2,{id:"upload--upsert-a-lexicon",children:"Upload / upsert a lexicon"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"POST /admin/lexicons\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl -X POST http://localhost:3000/admin/lexicons \\\n -H "$AUTH" \\\n -H "Content-Type: application/json" \\\n -d \'{\n "lexicon_json": { "lexicon": 1, "id": "xyz.statusphere.status", "defs": { "main": { "type": "record", "key": "tid", "record": { "type": "object", "required": ["status", "createdAt"], "properties": { "status": { "type": "string", "maxGraphemes": 1 }, "createdAt": { "type": "string", "format": "datetime" } } } } } },\n "backfill": true,\n "target_collection": null\n }\'\n'})}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Field"}),(0,r.jsx)(n.th,{children:"Type"}),(0,r.jsx)(n.th,{children:"Required"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"lexicon_json"})}),(0,r.jsx)(n.td,{children:"object"}),(0,r.jsx)(n.td,{children:"yes"}),(0,r.jsxs)(n.td,{children:["Raw lexicon JSON (must have ",(0,r.jsx)(n.code,{children:"lexicon: 1"})," and ",(0,r.jsx)(n.code,{children:"id"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"backfill"})}),(0,r.jsx)(n.td,{children:"boolean"}),(0,r.jsx)(n.td,{children:"no"}),(0,r.jsxs)(n.td,{children:["Whether uploading triggers historical backfill (default ",(0,r.jsx)(n.code,{children:"true"}),")"]})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"target_collection"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"no"}),(0,r.jsx)(n.td,{children:"For query/procedure lexicons, the record collection they operate on"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"script"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"no"}),(0,r.jsx)(n.td,{children:"Lua script for query/procedure endpoints"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"index_hook"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"no"}),(0,r.jsxs)(n.td,{children:[(0,r.jsx)(n.a,{href:"/guides/index-hooks",children:"Index hook"})," Lua script for record lexicons"]})]})]})]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"201 Created"})," (new) or ",(0,r.jsx)(n.code,{children:"200 OK"})," (upsert)"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "id": "xyz.statusphere.status",\n "revision": 1\n}\n'})}),"\n",(0,r.jsx)(n.h2,{id:"list-lexicons",children:"List lexicons"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"GET /admin/lexicons\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl http://localhost:3000/admin/lexicons -H "$AUTH"\n'})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"200 OK"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'[\n {\n "id": "xyz.statusphere.status",\n "revision": 1,\n "lexicon_type": "record",\n "backfill": true,\n "created_at": "2025-01-01T00:00:00Z",\n "updated_at": "2025-01-01T00:00:00Z"\n }\n]\n'})}),"\n",(0,r.jsx)(n.h2,{id:"get-a-lexicon",children:"Get a lexicon"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"GET /admin/lexicons/{id}\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl http://localhost:3000/admin/lexicons/xyz.statusphere.status -H "$AUTH"\n'})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"200 OK"})," with full lexicon details including raw JSON."]}),"\n",(0,r.jsx)(n.h2,{id:"delete-a-lexicon",children:"Delete a lexicon"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"DELETE /admin/lexicons/{id}\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl -X DELETE http://localhost:3000/admin/lexicons/xyz.statusphere.status -H "$AUTH"\n'})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"204 No Content"})]}),"\n",(0,r.jsx)(n.h2,{id:"network-lexicons",children:"Network Lexicons"}),"\n",(0,r.jsxs)(n.p,{children:["Network lexicons are fetched from the atproto network via DNS TXT resolution and kept updated via the Jetstream subscription. See ",(0,r.jsx)(n.a,{href:"/guides/lexicons#network-lexicons",children:"Lexicons - Network lexicons"})," for background."]}),"\n",(0,r.jsx)(n.h3,{id:"add-a-network-lexicon",children:"Add a network lexicon"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"POST /admin/network-lexicons\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl -X POST http://localhost:3000/admin/network-lexicons \\\n -H "$AUTH" \\\n -H "Content-Type: application/json" \\\n -d \'{\n "nsid": "xyz.statusphere.status",\n "target_collection": null\n }\'\n'})}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Field"}),(0,r.jsx)(n.th,{children:"Type"}),(0,r.jsx)(n.th,{children:"Required"}),(0,r.jsx)(n.th,{children:"Description"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"nsid"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"yes"}),(0,r.jsx)(n.td,{children:"The NSID of the lexicon to watch"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"target_collection"})}),(0,r.jsx)(n.td,{children:"string"}),(0,r.jsx)(n.td,{children:"no"}),(0,r.jsx)(n.td,{children:"For query/procedure lexicons, the record collection they operate on"})]})]})]}),"\n",(0,r.jsx)(n.p,{children:"HappyView resolves the NSID authority via DNS TXT, fetches the lexicon from the authority's PDS, parses it, and stores it."}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"201 Created"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "nsid": "xyz.statusphere.status",\n "authority_did": "did:plc:authority",\n "revision": 1\n}\n'})}),"\n",(0,r.jsx)(n.h3,{id:"list-network-lexicons",children:"List network lexicons"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"GET /admin/network-lexicons\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl http://localhost:3000/admin/network-lexicons -H "$AUTH"\n'})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"200 OK"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'[\n {\n "nsid": "xyz.statusphere.status",\n "authority_did": "did:plc:authority",\n "target_collection": null,\n "last_fetched_at": "2025-01-01T00:00:00Z",\n "created_at": "2025-01-01T00:00:00Z"\n }\n]\n'})}),"\n",(0,r.jsx)(n.h3,{id:"remove-a-network-lexicon",children:"Remove a network lexicon"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"DELETE /admin/network-lexicons/{nsid}\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl -X DELETE http://localhost:3000/admin/network-lexicons/xyz.statusphere.status \\\n -H "$AUTH"\n'})}),"\n",(0,r.jsxs)(n.p,{children:["Removes the network lexicon tracking and also deletes the lexicon from the ",(0,r.jsx)(n.code,{children:"lexicons"})," table and in-memory registry."]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"204 No Content"})]})]})}function h(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(a,{...e})}):a(e)}},2560:(e,n,s)=>{s.d(n,{R:()=>t,x:()=>d});var i=s(63);const r={},c=i.createContext(r);function t(e){const n=i.useContext(c);return i.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/0a7e20de.0ed755f3.js b/assets/js/0a7e20de.0ed755f3.js
new file mode 100644
index 0000000..b0ebd57
--- /dev/null
+++ b/assets/js/0a7e20de.0ed755f3.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_happyview_docs=self.webpackChunk_happyview_docs||[]).push([[5309],{2969:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>l,contentTitle:()=>i,default:()=>u,frontMatter:()=>t,metadata:()=>s,toc:()=>c});const s=JSON.parse('{"id":"reference/lua/json-api","title":"JSON API","description":"The json global provides JSON serialization and deserialization. Available in queries, procedures, and index hooks.","source":"@site/docs/reference/lua/json-api.md","sourceDirName":"reference/lua","slug":"/reference/lua/json-api","permalink":"/reference/lua/json-api","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"atproto API","permalink":"/reference/lua/atproto-api"},"next":{"title":"Utility Globals","permalink":"/reference/lua/utility-globals"}}');var r=o(199),a=o(2560);const t={},i="JSON API",l={},c=[{value:"json.encode",id:"jsonencode",level:2},{value:"json.decode",id:"jsondecode",level:2}];function d(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",...(0,a.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"json-api",children:"JSON API"})}),"\n",(0,r.jsxs)(n.p,{children:["The ",(0,r.jsx)(n.code,{children:"json"})," global provides JSON serialization and deserialization. Available in queries, procedures, and ",(0,r.jsx)(n.a,{href:"/guides/index-hooks",children:"index hooks"}),"."]}),"\n",(0,r.jsx)(n.h2,{id:"jsonencode",children:"json.encode"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-lua",children:'local str = json.encode({ key = "value", items = { 1, 2, 3 } })\n-- \'{"key":"value","items":[1,2,3]}\'\n'})}),"\n",(0,r.jsx)(n.p,{children:"Converts a Lua table to a JSON string."}),"\n",(0,r.jsx)(n.h2,{id:"jsondecode",children:"json.decode"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-lua",children:'local tbl = json.decode(\'{"key": "value"}\')\n-- tbl.key == "value"\n'})}),"\n",(0,r.jsx)(n.p,{children:"Parses a JSON string into a Lua table. Returns an error if the input is not valid JSON."})]})}function u(e={}){const{wrapper:n}={...(0,a.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},2560:(e,n,o)=>{o.d(n,{R:()=>t,x:()=>i});var s=o(63);const r={},a=s.createContext(r);function t(e){const n=s.useContext(a);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),s.createElement(a.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/0eda1588.4f831c59.js b/assets/js/0eda1588.4f831c59.js
new file mode 100644
index 0000000..92352b3
--- /dev/null
+++ b/assets/js/0eda1588.4f831c59.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_happyview_docs=self.webpackChunk_happyview_docs||[]).push([[9329],{7045:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>i,contentTitle:()=>a,default:()=>u,frontMatter:()=>o,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"reference/admin/stats","title":"Admin API: Stats","description":"Record counts","source":"@site/docs/reference/admin/stats.md","sourceDirName":"reference/admin","slug":"/reference/admin/stats","permalink":"/reference/admin/stats","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"Lexicons","permalink":"/reference/admin/lexicons"},"next":{"title":"Backfill","permalink":"/reference/admin/backfill"}}');var r=t(199),c=t(2560);const o={},a="Admin API: Stats",i={},d=[{value:"Record counts",id:"record-counts",level:2}];function l(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",strong:"strong",...(0,c.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"admin-api-stats",children:"Admin API: Stats"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'# All examples assume $TOKEN is an API key (hv_...)\nAUTH="Authorization: Bearer $TOKEN"\n'})}),"\n",(0,r.jsx)(n.h2,{id:"record-counts",children:"Record counts"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{children:"GET /admin/stats\n"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-sh",children:'curl http://localhost:3000/admin/stats -H "$AUTH"\n'})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"Response"}),": ",(0,r.jsx)(n.code,{children:"200 OK"})]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-json",children:'{\n "total_records": 12345,\n "collections": [{ "collection": "xyz.statusphere.status", "count": 500 }]\n}\n'})})]})}function u(e={}){const{wrapper:n}={...(0,c.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(l,{...e})}):l(e)}},2560:(e,n,t)=>{t.d(n,{R:()=>o,x:()=>a});var s=t(63);const r={},c=s.createContext(r);function o(e){const n=s.useContext(c);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function a(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),s.createElement(c.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/111eee19.94292821.js b/assets/js/111eee19.94292821.js
deleted file mode 100644
index b45dd87..0000000
--- a/assets/js/111eee19.94292821.js
+++ /dev/null
@@ -1 +0,0 @@
-"use strict";(self.webpackChunkhappyview_docs=self.webpackChunkhappyview_docs||[]).push([[8779],{9071(e,n,r){r.r(n),r.d(n,{assets:()=>l,contentTitle:()=>c,default:()=>h,frontMatter:()=>t,metadata:()=>s,toc:()=>d});const s=JSON.parse('{"id":"reference/troubleshooting","title":"Troubleshooting","description":"Common issues and how to resolve them.","source":"@site/docs/reference/troubleshooting.md","sourceDirName":"reference","slug":"/reference/troubleshooting","permalink":"/reference/troubleshooting","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"docs","previous":{"title":"Architecture","permalink":"/reference/architecture"},"next":{"title":"Production","permalink":"/reference/production-deployment"}}');var i=r(4848),o=r(8453);const t={},c="Troubleshooting",l={},d=[{value:"XRPC endpoint returns 404",id:"xrpc-endpoint-returns-404",level:2},{value:"Queries return empty results",id:"queries-return-empty-results",level:2},{value:"Procedure returns 401 Unauthorized",id:"procedure-returns-401-unauthorized",level:2},{value:"Admin endpoints return 403 Forbidden",id:"admin-endpoints-return-403-forbidden",level:2},{value:"Lua script errors",id:"lua-script-errors",level:2},{value:"Backfill job stuck in "pending" or "running"",id:"backfill-job-stuck-in-pending-or-running",level:2},{value:"Records not appearing in real time",id:"records-not-appearing-in-real-time",level:2},{value:"OAuth or login issues",id:"oauth-or-login-issues",level:2},{value:"Database connection errors",id:"database-connection-errors",level:2}];function a(e){const n={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,o.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.header,{children:(0,i.jsx)(n.h1,{id:"troubleshooting",children:"Troubleshooting"})}),"\n",(0,i.jsx)(n.p,{children:"Common issues and how to resolve them."}),"\n",(0,i.jsx)(n.h2,{id:"xrpc-endpoint-returns-404",children:"XRPC endpoint returns 404"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Symptom"}),": ",(0,i.jsx)(n.code,{children:"GET /xrpc/your.method.name"})," returns ",(0,i.jsx)(n.code,{children:'{"error": "method not found"}'}),"."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Causes"}),":"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["The lexicon hasn't been uploaded yet. Check with ",(0,i.jsx)(n.code,{children:"GET /admin/lexicons"})," or the ",(0,i.jsx)(n.a,{href:"/getting-started/dashboard",children:"dashboard"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["The lexicon's ",(0,i.jsx)(n.code,{children:"defs.main.type"})," doesn't match the HTTP method. Queries are ",(0,i.jsx)(n.code,{children:"GET"}),", procedures are ",(0,i.jsx)(n.code,{children:"POST"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["The NSID in the URL doesn't match the ",(0,i.jsx)(n.code,{children:"id"})," field in the uploaded lexicon JSON."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"queries-return-empty-results",children:"Queries return empty results"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Symptom"}),": The XRPC query endpoint returns ",(0,i.jsx)(n.code,{children:'{"records": []}'})," even though records should exist."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Causes"}),":"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["The query lexicon is missing a ",(0,i.jsx)(n.code,{children:"target_collection"}),". Without it, the query doesn't know which records to read. See ",(0,i.jsx)(n.a,{href:"/guides/lexicons#target-collection",children:"Lexicons - target_collection"}),"."]}),"\n",(0,i.jsxs)(n.li,{children:["The record-type lexicon hasn't finished backfilling. Check backfill status with ",(0,i.jsx)(n.code,{children:"GET /admin/backfill/status"})," or the dashboard."]}),"\n",(0,i.jsxs)(n.li,{children:["Records exist on the network but HappyView hasn't indexed them yet. Tap only picks up new events from when the collection filter was added. Use ",(0,i.jsx)(n.a,{href:"/guides/backfill",children:"backfill"})," for historical records."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"procedure-returns-401-unauthorized",children:"Procedure returns 401 Unauthorized"}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Symptom"}),": ",(0,i.jsx)(n.code,{children:"POST /xrpc/your.method.name"})," returns ",(0,i.jsx)(n.code,{children:'{"error": "..."}'})," with status 401."]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.strong,{children:"Causes"}),":"]}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:["The ",(0,i.jsx)(n.code,{children:"Authorization: Bearer