<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
    <id>https://helpkb.markmoffat.com</id>
    <title>helpkb - Open-source and easy to use knowledge base/faq</title>
    <updated>2024-01-21T09:18:33.429Z</updated>
    <generator>squido</generator>
    <link rel="alternate" href="https://helpkb.markmoffat.com"/>
    <link rel="self" href="https://helpkb.markmoffat.com/atom"/>
    <subtitle>A superfast and easy to use knowledge base/faq to help your customers get the info they need, when they need it most.</subtitle>
    <icon>https://helpkb.markmoffat.com/favicon.png</icon>
    <entry>
        <title type="html"><![CDATA[Users]]></title>
        <id>https://helpkb.markmoffat.com/documentation/users/</id>
        <link href="https://helpkb.markmoffat.com/documentation/users/"/>
        <updated>2022-06-16T01:56:00.000Z</updated>
        <summary type="html"><![CDATA[Documentation - The users API enables you to manage anything from selecting to deleting and updating users | helpkb]]></summary>
        <content type="html"><![CDATA[<h3 id="gets-a-list-of-users">Gets a list of users</h3>
<p>Retrieves a list of users</p>
<p><strong>URL</strong> : <code>/api/users</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example response:</p>
<pre><code class="language-json">[
    {
        id: &quot;6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb&quot;,
        email: &quot;[email protected]&quot;,
        name: &quot;Jim Smith&quot;,
        enabled: true,
        admin: true,
        owner: true,
        createdAt: 2022-06-12T06:50:00.021Z,
        updatedAt: 2022-06-12T06:50:00.021Z
    }
]
</code></pre>
<h3 id="gets-a-single-user">Gets a single user</h3>
<p>Search an article using a keyword</p>
<p><strong>URL</strong> : <code>/api/user/:id</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: Single user</p>
<h4 id="success-response-1">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example response:</p>
<pre><code class="language-json">{
    id: &quot;6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb&quot;,
    email: &quot;[email protected]&quot;,
    name: &quot;Jim Smith&quot;,
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}
</code></pre>
<h3 id="updates-a-single-user">Updates a single user</h3>
<p>Updates a given user</p>
<p><strong>URL</strong> : <code>/api/user/save</code></p>
<p><strong>Method</strong> : <code>PUT</code></p>
<p><strong>Auth required</strong> : NO</p>
<p><strong>Limit</strong>: Single user</p>
<h4 id="success-response-2">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example request:</p>
<pre><code class="language-json">{
    id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8b&quot;,
    email: &quot;[email protected]&quot;,
    name: &quot;Jim Smith&quot;,
    enabled: true,
    admin: true
}
</code></pre>
<p>Example response:</p>
<pre><code class="language-json">{
    id: &quot;6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb&quot;,
    email: &quot;[email protected]&quot;,
    name: &quot;Jim Smith&quot;,
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}
</code></pre>
<h3 id="insert-a-new-user">Insert a new user</h3>
<p>Inserts a new user</p>
<p><strong>URL</strong> : <code>/api/user/insert</code></p>
<p><strong>Method</strong> : <code>PUT</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-3">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example request:</p>
<pre><code class="language-json">{
    email: &quot;[email protected]&quot;,
    name: &quot;Jim Smith&quot;
}
</code></pre>
<p>Example response:</p>
<pre><code class="language-json">{
    id: &quot;6d4bd2d0-1dc0-435f-8c9c-ac55776b55eb&quot;,
    email: &quot;[email protected]&quot;,
    name: &quot;Jim Smith&quot;,
    enabled: true,
    admin: true,
    owner: true,
    createdAt: 2022-06-12T06:50:00.021Z,
    updatedAt: 2022-06-12T06:50:00.021Z
}
</code></pre>
<h3 id="deletes-existing-article">Deletes existing article</h3>
<p>Deletes an existing article content</p>
<p><strong>URL</strong> : <code>/api/user/delete/:id</code></p>
<p><strong>Method</strong> : <code>DELETE</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-4">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example response:</p>
<pre><code class="language-json">{
    <span class="hljs-attr">&quot;success&quot;</span>
}
</code></pre>
]]></content>
    </entry>
    <entry>
        <title type="html"><![CDATA[Articles]]></title>
        <id>https://helpkb.markmoffat.com/documentation/articles/</id>
        <link href="https://helpkb.markmoffat.com/documentation/articles/"/>
        <updated>2022-06-16T01:56:00.000Z</updated>
        <summary type="html"><![CDATA[Documentation - The articles API enables you to manage anything from selecting to deleting and updating articles | helpkb]]></summary>
        <content type="html"><![CDATA[<h3 id="get-single-article">Get single article</h3>
<p>Retrieve a single article using the article Url</p>
<p><strong>URL</strong> : <code>/api/article/:articleurl</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : NO</p>
<p><strong>Limit</strong>: Single article</p>
<h4 id="success-response">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>An example response:</p>
<pre><code class="language-json">{
    id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8b&quot;,
    url: &quot;hello-world&quot;,
    title: &quot;Hello world&quot;,
    content: &quot;--- content ---&quot;,
    published: true,
    category: &quot;General&quot;,
    pinned: true,
    publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
    views: 7,
    createdAt: 2022-06-12T06:50:13.724Z,
    updatedAt: 2022-06-16T11:09:09.259Z
}
</code></pre>
<h3 id="search-articles">Search articles</h3>
<p>Search an article using a keyword</p>
<p><strong>URL</strong> : <code>/api/search/:searchparam</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : NO</p>
<p><strong>Limit</strong>: 10 articles</p>
<h4 id="success-response-1">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>An example response:</p>
<pre><code class="language-json">[
    {
        id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8b&quot;,
        url: &quot;hello-world&quot;,
        title: &quot;Hello world&quot;,
        content: &quot;--- content ---&quot;,
        published: true,
        category: &quot;General&quot;,
        pinned: true,
        publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8c&quot;,
        url: &quot;hello-world-two&quot;,
        title: &quot;Hello world two&quot;,
        content: &quot;--- content ---&quot;,
        published: true,
        category: &quot;General&quot;,
        pinned: true,
        publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]
</code></pre>
<h3 id="get-recent-articles">Get recent articles</h3>
<p>Gets a list of recent articles</p>
<p><strong>URL</strong> : <code>/api/search/count/:num</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : NO</p>
<p><strong>Limit</strong>: Number supplied in parameter. Cannot exceeedt the <code>ARTICLE_LIMIT_RETURNED</code> environment variable.</p>
<h4 id="success-response-2">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>An example response:</p>
<pre><code class="language-json">[
    {
        id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8b&quot;,
        url: &quot;hello-world&quot;,
        title: &quot;Hello world&quot;,
        content: &quot;--- content ---&quot;,
        published: true,
        category: &quot;General&quot;,
        pinned: true,
        publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8c&quot;,
        url: &quot;hello-world-two&quot;,
        title: &quot;Hello world two&quot;,
        content: &quot;--- content ---&quot;,
        published: true,
        category: &quot;General&quot;,
        pinned: true,
        publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]
</code></pre>
<h3 id="insert-a-new-article">Insert a new article</h3>
<p>Inserts a new article</p>
<p><strong>URL</strong> : <code>/api/article/insert</code></p>
<p><strong>Method</strong> : <code>PUT</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-3">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example request:</p>
<pre><code class="language-json">{
    content: &quot;--- content ---&quot;
}
</code></pre>
<p>Example response:</p>
<pre><code class="language-json">{
    articleId: &quot;b27e97f5-67e7-4883-9402-c7686da28f8b&quot;
}
</code></pre>
<h3 id="update-existing-article">Update existing article</h3>
<p>Updates an existing article content</p>
<p><strong>URL</strong> : <code>/api/article/save</code></p>
<p><strong>Method</strong> : <code>PUT</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-4">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example request:</p>
<pre><code class="language-json">{
    content: &quot;--- content ---&quot;,
    id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8c&quot;
}
</code></pre>
<p>Example response:</p>
<pre><code class="language-json">{
    id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8c&quot;,
    url: &quot;hello-world-two&quot;,
    title: &quot;Hello world two&quot;,
    content: &quot;--- content ---&quot;,
    published: true,
    category: &quot;General&quot;,
    pinned: true,
    publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
    views: 7,
    createdAt: 2022-06-12T06:50:13.724Z,
    updatedAt: 2022-06-16T11:09:09.259Z
}
</code></pre>
<h3 id="deletes-existing-article">Deletes existing article</h3>
<p>Deletes an existing article</p>
<p><strong>URL</strong> : <code>/api/article/delete/:id</code></p>
<p><strong>Method</strong> : <code>DELETE</code></p>
<p><strong>Auth required</strong> : YES</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-5">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example response:</p>
<pre><code class="language-json">{
    <span class="hljs-attr">&quot;success&quot;</span>
}
</code></pre>
<h3 id="get-articles-per-category">Get articles per category</h3>
<p>Gets the articles in a given category</p>
<p><strong>URL</strong> : <code>/api/category/:category</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : NO</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-6">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example response:</p>
<pre><code class="language-json">[
    {
        id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8b&quot;,
        url: &quot;hello-world&quot;,
        title: &quot;Hello world&quot;,
        content: &quot;--- content ---&quot;,
        published: true,
        category: &quot;General&quot;,
        pinned: true,
        publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    },
    {
        id: &quot;b27e97f5-67e7-4883-9402-c7686da28f8c&quot;,
        url: &quot;hello-world-two&quot;,
        title: &quot;Hello world two&quot;,
        content: &quot;--- content ---&quot;,
        published: true,
        category: &quot;General&quot;,
        pinned: true,
        publishedDate: &quot;2022-06-10T10:50:29.062Z&quot;,
        views: 7,
        createdAt: 2022-06-12T06:50:13.724Z,
        updatedAt: 2022-06-16T11:09:09.259Z
    }
]
</code></pre>
<h3 id="get-a-list-of-categories">Get a list of categories</h3>
<p>Gets an array of available categories</p>
<p><strong>URL</strong> : <code>/api/categories</code></p>
<p><strong>Method</strong> : <code>GET</code></p>
<p><strong>Auth required</strong> : NO</p>
<p><strong>Limit</strong>: None</p>
<h4 id="success-response-7">Success Response</h4>
<p><strong>Code</strong> : <code>200 OK</code></p>
<p><strong>Content examples</strong></p>
<p>Example response:</p>
<pre><code class="language-json">[
    { category: &quot;Configuration&quot;, count: &quot;2&quot; },
    { category: &quot;General&quot;, count: &quot;1&quot; },
    { category: &quot;Getting started&quot;, count: &quot;1&quot; }
]
</code></pre>
]]></content>
    </entry>
    <entry>
        <title type="html"><![CDATA[Features]]></title>
        <id>https://helpkb.markmoffat.com/features/</id>
        <link href="https://helpkb.markmoffat.com/features/"/>
        <updated>2022-06-16T01:56:00.000Z</updated>
        <summary type="html"><![CDATA[helpkb features - outlining the features supported by the core functionality of helpkb]]></summary>
        <content type="html"><![CDATA[<table class="table table-hover table-bordered">
<thead>
<tr>
<th>Feature</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>Sitemap</td>
<td>Sitemaps are automatically generated. Just submit to Google.</td>
</tr>
<tr>
<td><a href="https://en.wikipedia.org/wiki/Markdown">Markdown</a> syntax</td>
<td>The powerful and easy to learn <a href="https://en.wikipedia.org/wiki/Markdown">markdown</a> syntax is used for writing posts</td>
</tr>
<tr>
<td>Built with <a href="https://nodejs.org/">Node.js</a> (Javascript)</td>
<td>Built with <a href="https://nodejs.org/">Node.js</a> meaning anyone with knowledge of Javascript can extend helpkb.</td>
</tr>
<tr>
<td>Multiple environment support</td>
<td>Create a <a href="https://helpkb-docs.markmoffat.com/article/environment-variables/">config</a> file and setup options for different environments. Eg: Development vs Production</td>
</tr>
<tr>
<td>Easy extended with Nextjs/React knowledge</td>
<td>Quite often not needed but can easy be written to extend the application</td>
</tr>
</tbody>
</table>
]]></content>
    </entry>
    <entry>
        <title type="html"><![CDATA[Documentation]]></title>
        <id>https://helpkb.markmoffat.com/documentation/</id>
        <link href="https://helpkb.markmoffat.com/documentation/"/>
        <updated>2022-06-16T01:56:00.000Z</updated>
        <summary type="html"><![CDATA[helpkb documentation - Dive into the offical helpkb API documentation to manage everything from your articles to your users.]]></summary>
        <content type="html"><![CDATA[<p>See the <code>helpkb</code> API endpoint documentation below:</p>
<h2>
    <a href="/documentation/articles/">Articles</a>
</h2>
<h2>
    <a href="/documentation/users/">Users</a>
</h2>
<hr>
<h1 id="demo-%2F-support">Demo / Support</h1>
<p>A <code>helpkb</code> instance which has guides and support articles:</p>
<h2>
    <a href="https://helpkb-docs.markmoffat.com">Support website</a>
</h2>]]></content>
    </entry>
</feed>