[{"data":1,"prerenderedAt":25},["ShallowReactive",2],{"doc-getting-started":3},{"html":4,"headings":5},"\u003Cblockquote>\n\u003Cp>\u003Cstrong>HelpBites is in public beta.\u003C\u002Fstrong> It runs in production for its author and every feature in these docs is on \u003Ccode>main\u003C\u002Fcode>,\nbut expect rough edges, take a backup before you upgrade (\u003Ca href=\"\u002Fdocs\u002Fself-host#upgrades\">Self-hosting → Upgrades\u003C\u002Fa>), and\nread the \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Felrumo\u002Fhelp-bites-oss\u002Fblob\u002Fmain\u002FCHANGELOG.md\" target=\"_blank\" rel=\"noopener\">release notes\u003C\u002Fa> first. Found a bug? \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Felrumo\u002Fhelp-bites-oss\u002Fissues\" target=\"_blank\" rel=\"noopener\">Open an issue\u003C\u002Fa>.\u003C\u002Fp>\n\u003C\u002Fblockquote>\n\u003Cp>This is the shortest path from nothing to a working support inbox, feedback board and changelog. It takes about ten\nminutes, plus whatever DNS needs. You need Docker with the Compose plugin and a machine to run it on. Nothing else.\u003C\u002Fp>\n\u003Ch2 id=\"1-start-it\">1. Start it\u003Ca class=\"heading-anchor\" href=\"#1-start-it\" aria-label=\"Link to this section\">#\u003C\u002Fa>\u003C\u002Fh2>\n\u003Cdiv class=\"code-block\">\u003Cbutton type=\"button\" class=\"copy-btn\" data-copy aria-label=\"Copy to clipboard\">Copy\u003C\u002Fbutton>\u003Cpre class=\"shj-lang-bash\">\u003Ccode>\u003Cspan class=\"shj-syn-func\">git\u003C\u002Fspan> clone https:\u002F\u002Fgithub.com\u002Felrumo\u002Fhelp-bites-oss.git \u003Cspan class=\"shj-syn-kwd\">&#38;&#38;\u003C\u002Fspan> \u003Cspan class=\"shj-syn-func\">cd\u003C\u002Fspan> help-bites-oss\nscripts\u002Finstall.sh                 \u003Cspan class=\"shj-syn-cmnt\"># a trial on this machine: http:\u002F\u002Flocalhost:3100\u003C\u002Fspan>\n\u003Cspan class=\"shj-syn-func\">docker\u003C\u002Fspan> compose up\u003Cspan class=\"shj-syn-kwd\"> -d\u003C\u002Fspan>               \u003Cspan class=\"shj-syn-cmnt\"># pulls elrumo\u002Fhelpbites from Docker Hub\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Fdiv>\n\u003Cp>\u003Ccode>install.sh\u003C\u002Fcode> writes a \u003Ccode>.env\u003C\u002Fcode> with freshly generated secrets. For a real server pass your domain\n(\u003Ccode>scripts\u002Finstall.sh help.example.com\u003C\u002Fcode>), point \u003Ccode>help.example.com\u003C\u002Fcode> and \u003Ccode>files.help.example.com\u003C\u002Fcode> at the server first, and the\nbundled Caddy gets the HTTPS certificates. The first boot takes a minute or two: the app creates its schema, runs the\nmigrations and loads the search model. Watch it with \u003Ccode>docker compose logs -f app\u003C\u002Fcode>, and check\n\u003Ccode>curl http:\u002F\u002Flocalhost:3100\u002Fv1\u002Fhealth\u003C\u002Fcode> answers \u003Ccode>&quot;ok&quot;: true\u003C\u002Fcode>.\u003C\u002Fp>\n\u003Cp>The image is on \u003Ca href=\"https:\u002F\u002Fhub.docker.com\u002Fr\u002Felrumo\u002Fhelpbites\" target=\"_blank\" rel=\"noopener\">Docker Hub\u003C\u002Fa> (\u003Ccode>elrumo\u002Fhelpbites\u003C\u002Fcode>) and\n\u003Ca href=\"https:\u002F\u002Fgithub.com\u002Felrumo\u002Fhelp-bites-oss\u002Fpkgs\u002Fcontainer\u002Fhelpbites\" target=\"_blank\" rel=\"noopener\">GHCR\u003C\u002Fa>. Tags: \u003Ccode>latest\u003C\u002Fcode> (the newest release), \u003Ccode>0.2.0\u003C\u002Fcode>\n(one release, pin it with \u003Ccode>HELPBITES_VERSION=0.2.0\u003C\u002Fcode> in \u003Ccode>.env\u003C\u002Fcode>) and \u003Ccode>edge\u003C\u002Fcode> (every push to \u003Ccode>main\u003C\u002Fcode>, for the curious).\nOther ways to host it (Dokploy, your own proxy, split web and worker containers) are in \u003Ca href=\"\u002Fdocs\u002Fself-host\">Self-hosting\u003C\u002Fa>.\u003C\u002Fp>\n\u003Ch2 id=\"2-create-the-first-operator\">2. Create the first operator\u003Ca class=\"heading-anchor\" href=\"#2-create-the-first-operator\" aria-label=\"Link to this section\">#\u003C\u002Fa>\u003C\u002Fh2>\n\u003Cp>Open the site. A fresh install asks you to create the first operator account; whoever does so first owns the instance,\nso do it straight away (or set \u003Ccode>SETUP_TOKEN\u003C\u002Fcode> in \u003Ccode>.env\u003C\u002Fcode> and the form asks for it). That also creates your workspace.\nInvite teammates later from \u003Cstrong>Settings → Team\u003C\u002Fstrong>.\u003C\u002Fp>\n\u003Cp>Want to look around before you install anything? The \u003Ca href=\"https:\u002F\u002Fhelpbites.app\u002Fdemo\" target=\"_blank\" rel=\"noopener\">demo\u003C\u002Fa> (\u003Ccode>\u002Fdemo\u003C\u002Fcode> on any HelpBites site) is the panel with sample data and no sign-in.\u003C\u002Fp>\n\u003Ch2 id=\"3-create-a-project\">3. Create a project\u003Ca class=\"heading-anchor\" href=\"#3-create-a-project\" aria-label=\"Link to this section\">#\u003C\u002Fa>\u003C\u002Fh2>\n\u003Cp>A \u003Cstrong>project\u003C\u002Fstrong> is one of your apps or sites: its own inbox, feedback board, roadmap, changelog, knowledge and email.\n\u003Cstrong>Projects → New project\u003C\u002Fstrong> gives you a public key (\u003Ccode>pk_…\u003C\u002Fcode>, safe in a page) and a secret (\u003Ccode>sk_…\u003C\u002Fcode>, for your server only).\nSet the site URL and the origins that may load the widget.\u003C\u002Fp>\n\u003Cp>The project's \u003Cstrong>Overview\u003C\u002Fstrong> carries a setup checklist: which parts HelpBites has seen working (the widget loading on your\nsite, a signed token arriving, mail that can go out, an assistant that is live) and which still need you. Each row opens\nthe page that fixes it.\u003C\u002Fp>\n\u003Ch2 id=\"4-put-it-on-your-site\">4. Put it on your site\u003Ca class=\"heading-anchor\" href=\"#4-put-it-on-your-site\" aria-label=\"Link to this section\">#\u003C\u002Fa>\u003C\u002Fh2>\n\u003Cp>The one-line version, a floating chat on any page:\u003C\u002Fp>\n\u003Cdiv class=\"code-block\">\u003Cbutton type=\"button\" class=\"copy-btn\" data-copy aria-label=\"Copy to clipboard\">Copy\u003C\u002Fbutton>\u003Cpre class=\"shj-lang-html\">\u003Ccode>\u003Cspan class=\"shj-syn-var\">\u003C\u002Fspan>\u003Cspan class=\"shj-syn-oper\">&lt;\u003C\u002Fspan>\u003Cspan class=\"shj-syn-var\">script\u003C\u002Fspan> \u003Cspan class=\"shj-syn-class\">src\u003C\u002Fspan>\u003Cspan class=\"shj-syn-str\">\u003C\u002Fspan>\u003Cspan class=\"shj-syn-oper\">=\u003C\u002Fspan>\u003Cspan class=\"shj-syn-str\">\"https:\u002F\u002FYOUR-HELPBITES\u002Fwidget.js\"\u003C\u002Fspan> \u003Cspan class=\"shj-syn-class\">data-project\u003C\u002Fspan>\u003Cspan class=\"shj-syn-str\">\u003C\u002Fspan>\u003Cspan class=\"shj-syn-oper\">=\u003C\u002Fspan>\u003Cspan class=\"shj-syn-str\">\"pk_…\"\u003C\u002Fspan> \u003Cspan class=\"shj-syn-class\">defer\u003C\u002Fspan>\u003Cspan class=\"shj-syn-oper\">&gt;\u003C\u002Fspan>\u003Cspan class=\"shj-syn-var\">\u003C\u002Fspan>\u003Cspan class=\"shj-syn-oper\">&lt;\u002F\u003C\u002Fspan>\u003Cspan class=\"shj-syn-var\">script\u003C\u002Fspan>\u003Cspan class=\"shj-syn-oper\">&gt;\u003C\u002Fspan>\u003C\u002Fcode>\u003C\u002Fpre>\u003C\u002Fdiv>\n\u003Cp>The feedback board, roadmap and changelog are one script tag each (\u003Ccode>\u002Ffeedback.js\u003C\u002Fcode>, \u003Ccode>\u002Fchangelog.js\u003C\u002Fcode>), or one\n\u003Ccode>\u002Fhelpbites.js\u003C\u002Fcode> that adds whatever the project has switched on. If your app has signed-in users, sign an identity token\non your server so conversations belong to the right person: \u003Ca href=\"\u002Fdocs\u002Fconnect\">Connect your app\u003C\u002Fa> has the Node, Python and\ncurl versions and the Web and Swift snippets. Everything the panel does is also an API (\u003Ccode>\u002F_docs\u002Fscalar\u003C\u002Fcode> on your instance).\u003C\u002Fp>\n\u003Ch2 id=\"5-switch-on-the-rest\">5. Switch on the rest\u003Ca class=\"heading-anchor\" href=\"#5-switch-on-the-rest\" aria-label=\"Link to this section\">#\u003C\u002Fa>\u003C\u002Fh2>\n\u003Cp>Out of the box you have the inbox, feedback board, roadmap, changelog, knowledge base, onboarding, forms, legal\ndocuments and pricing tables. These need an account or a key of yours, and each is optional:\u003C\u002Fp>\n\u003Cdiv class=\"table-wrap\">\u003Ctable>\n\u003Cthead>\n\u003Ctr>\n\u003Cth>You want\u003C\u002Fth>\n\u003Cth>You need\u003C\u002Fth>\n\u003Cth>Guide\u003C\u002Fth>\n\u003C\u002Ftr>\n\u003C\u002Fthead>\n\u003Ctbody>\n\u003Ctr>\n\u003Ctd>AI replies, drafts, titles, translations\u003C\u002Ftd>\n\u003Ctd>An API key from any OpenAI-compatible provider\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fsetup#ai\">Set up AI\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Email to your users (replies, notifications, campaigns)\u003C\u002Ftd>\n\u003Ctd>A Mailgun account\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fsetup#email\">Set up email\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Customers emailing \u003Ccode>support@yourdomain\u003C\u002Fcode> into the inbox\u003C\u002Ftd>\n\u003Ctd>Mailgun, one DNS record or a forward\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Finbound-email\">Inbound email\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Commits and pull requests linked to the board, changelog drafted from pushes, AI error notes that read your code\u003C\u002Ftd>\n\u003Ctd>A GitHub App\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fsetup#github\">Connect GitHub\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Attachments and images\u003C\u002Ftd>\n\u003Ctd>An S3-compatible bucket (a bundled one is available)\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fsetup#storage\">Set up storage\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Error tracking with alerts\u003C\u002Ftd>\n\u003Ctd>GlitchTip or Bugsink next to the app\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fsetup#error-tracking\">Set up error tracking\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>Revenue and plan next to each conversation\u003C\u002Ftd>\n\u003Ctd>A Stripe (or other) key\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Frevenue\">Revenue\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>An assistant (Claude, Cursor, ChatGPT) working in your workspace\u003C\u002Ftd>\n\u003Ctd>Nothing extra\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fmcp\">MCP\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003Ctr>\n\u003Ctd>The iPhone, iPad and Mac app\u003C\u002Ftd>\n\u003Ctd>An Apple developer account to build it\u003C\u002Ftd>\n\u003Ctd>\u003Ca href=\"\u002Fdocs\u002Fdevelopment#the-native-app\">Native app\u003C\u002Fa>\u003C\u002Ftd>\n\u003C\u002Ftr>\n\u003C\u002Ftbody>\n\u003C\u002Ftable>\u003C\u002Fdiv>\n\u003Cp>All of them are in \u003Ca href=\"\u002Fdocs\u002Fsetup\">Setting things up\u003C\u002Fa>, with what to click and how to tell it worked.\u003C\u002Fp>\n\u003Ch2 id=\"next\">Next\u003Ca class=\"heading-anchor\" href=\"#next\" aria-label=\"Link to this section\">#\u003C\u002Fa>\u003C\u002Fh2>\n\u003Cul>\n\u003Cli>Teach the assistant your product: \u003Ca href=\"https:\u002F\u002Fgithub.com\u002Felrumo\u002Fhelp-bites-oss\u002Fblob\u002Fmain\u002Fdocs\u002FKNOWLEDGE.md\" target=\"_blank\" rel=\"noopener\">Knowledge\u003C\u002Fa>.\u003C\u002Fli>\n\u003Cli>Publish what you ship: \u003Cstrong>Project → Changelog\u003C\u002Fstrong>, or \u003Ccode>helpbites changelog\u003C\u002Fcode> from your repo (\u003Ca href=\"https:\u002F\u002Fgithub.com\u002Felrumo\u002Fhelp-bites-oss\u002Fblob\u002Fmain\u002Fcli\u002FREADME.md\" target=\"_blank\" rel=\"noopener\">the CLI\u003C\u002Fa>).\u003C\u002Fli>\n\u003Cli>Make the embeds yours: \u003Ca href=\"\u002Fdocs\u002Fbrand\">Brand kit\u003C\u002Fa> and \u003Ca href=\"\u002Fdocs\u002Fstyle\">Styling\u003C\u002Fa>.\u003C\u002Fli>\n\u003Cli>Back it up and keep it current: \u003Ca href=\"\u002Fdocs\u002Fself-host#backups\">Self-hosting → Backups\u003C\u002Fa> and \u003Ca href=\"\u002Fdocs\u002Fself-host#upgrades\">Upgrades\u003C\u002Fa>.\u003C\u002Fli>\n\u003Cli>Hack on it: \u003Ca href=\"\u002Fdocs\u002Fdevelopment\">Development\u003C\u002Fa>.\u003C\u002Fli>\n\u003C\u002Ful>\n",[6,10,13,16,19,22],{"id":7,"text":8,"level":9},"1-start-it","1. Start it",2,{"id":11,"text":12,"level":9},"2-create-the-first-operator","2. Create the first operator",{"id":14,"text":15,"level":9},"3-create-a-project","3. Create a project",{"id":17,"text":18,"level":9},"4-put-it-on-your-site","4. Put it on your site",{"id":20,"text":21,"level":9},"5-switch-on-the-rest","5. Switch on the rest",{"id":23,"text":24,"level":9},"next","Next",1794596525465]