{"id":19445183,"url":"https://github.com/thoth2357/openkb","last_synced_at":"2026-05-15T17:02:42.675Z","repository":{"id":252242190,"uuid":"837901339","full_name":"thoth2357/openKB","owner":"thoth2357","description":"📚 A streamlined Django-based Markdown knowledge base with powerful search capabilities. Simplify information retrieval without complex categorization - just search and find.","archived":false,"fork":false,"pushed_at":"2024-08-05T17:06:40.000Z","size":130,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-07T22:44:14.966Z","etag":null,"topics":["django","knowledge-base","search-oriented"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thoth2357.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-04T11:36:05.000Z","updated_at":"2024-10-11T03:36:04.000Z","dependencies_parsed_at":"2024-08-08T15:45:08.869Z","dependency_job_id":null,"html_url":"https://github.com/thoth2357/openKB","commit_stats":null,"previous_names":["thoth2357/openkb"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth2357%2FopenKB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth2357%2FopenKB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth2357%2FopenKB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thoth2357%2FopenKB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thoth2357","download_url":"https://codeload.github.com/thoth2357/openKB/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240629907,"owners_count":19831953,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","knowledge-base","search-oriented"],"created_at":"2024-11-10T16:09:37.761Z","updated_at":"2026-05-15T17:02:37.636Z","avatar_url":"https://github.com/thoth2357.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# openKB - Django Version\n\n![logo](https://files.markmoffat.com/openkb/logo.png)\n\nopenKB is a Markdown Knowledge base application (FAQ) built with Django. It is designed to be easy to use and install, with a focus on search functionality rather than nested categories. Simply search for what you want and select from the results.\n\n## Installation\n\n1. Clone the Repository: `git clone https://github.com/yourusername/openKB-Django.git \u0026\u0026 cd openKB-Django`\n2. Install dependencies using Poetry:\n\n   ```bash\n   poetry install\n   ```\n\n3. Apply migrations:\n\n   ```bash\n   poetry run python manage.py migrate\n   ```\n\n4. Start the application:\n\n   ```bash\n   poetry run python manage.py runserver\n   ```\n\n5. Go to [http://127.0.0.1:8000](http://127.0.0.1:8000) in your browser\n\n### Features\n\n- **Search**: openKB is a search-based Knowledge base (FAQ) using Django ORM to query and return relevant articles.\n- **Responsive Design**: Built using Bootstrap, allowing the application to be responsive and work on all devices.\n- **Markdown Support**: Uses Markdown for article content, allowing easy and flexible content formatting.\n- **User Authentication**: Includes user authentication with the ability to set up the first admin user on the first login attempt.\n- **File Management**: Allows file uploads with dynamic directory choices and file management capabilities.\n- **Google Analytics Integration**: Ability to add Google Analytics tracking code for monitoring site usage.\n- **Configurable Settings**: Customize website, article, display, and style settings via the admin interface.\n\n#### Screenshots\n\n##### Homepage\n\n![Homepage](https://files.markmoffat.com/openkb/homepage.png)\n\n##### Admin Editor\n\n![Editor](https://files.markmoffat.com/openkb/editor.png)\n\n##### Article View\n\n![Article view](https://files.markmoffat.com/openkb/articleview.png)\n\n##### Admin Article Management\n\n![Article filtering](https://files.markmoffat.com/openkb/articlefiltering.png)\n\n##### Managing Files\n\n![Files](https://files.markmoffat.com/openkb/files.png)\n\n### Admin\n\nVisit: [http://127.0.0.1:8000/admin](http://127.0.0.1:8000/admin)\n\nThe first-time setup will prompt the creation of an admin user. Subsequent logins will redirect to the standard login page.\n\n### Configuration\n\nConfiguration can be done via the `/settings` page in the admin interface or the settings page in the user interface.\n\n#### Website Settings\n\n- `website_title`: The title of your website.\n- `website_description`: A short description that appears in search engine results.\n- `show_website_logo`: Toggle to show or hide the website logo.\n- `base_url`: The root URL where your site is hosted. E.g., \u003chttp://example.com/\u003e\n- `allow_api_access`: Allow external systems to access site data via API.\n- `api_token`: The security token others will use to access your API.\n- `password_protect`: Require users to log in before accessing the site.\n- `index_article_body`: Include the text of articles in the search index.\n- `select_theme`: The visual theme for the site.\n- `select_language`: The language the site interface will appear in.\n- `show_logon_link`: Display a link for users to log on if needed.\n- `date_format`: Format in which dates are displayed on the site.\n- `article_suggestions_allowed`: Allow users to submit articles for potential inclusion.\n- `google_analytics_code`: Google Analytics code to track site usage.\n\n#### Article Settings\n\n- `allow_voting`: Allow users to vote on articles.\n- `show_article_meta`: Show article metadata, including published date and author.\n- `show_author_email`: Display the author's email in the metadata.\n- `article_links_open_new_page`: Open links in articles in a new page/tab.\n- `add_header_anchors`: Add HTML anchors to all heading tags for linking within articles.\n- `enable_editor_spellchecker`: Enable spellchecker in the editor.\n- `allow_article_versioning`: Track article versions with each save.\n- `allow_mermaid`: Enable Mermaid charts within articles.\n- `allow_mathjax`: Enable MathJax within articles.\n\n#### Display Settings\n\n- `number_of_top_articles`: Number of results shown on the homepage.\n- `show_published_date`: Display the published date next to results.\n- `show_view_count`: Display the view count next to results.\n- `update_view_count_when_logged_in`: Update view count when users are logged in.\n- `show_featured_articles`: Display featured articles in a sidebar.\n- `featured_article_count`: Number of featured articles shown.\n\n#### Style Settings\n\n- `header_background_color`, `footer_background_color`: Color settings for header and footer backgrounds.\n- `header_text_color`, `footer_text_color`: Color settings for header and footer texts.\n- `button_background_color`, `button_text_color`: Color settings for button backgrounds and texts.\n- `link_color`: Color setting for links.\n- `page_text_color`: Color setting for page text.\n- `page_font`: Font setting for the page.\n\n### Additional Features\n\n- **Dynamic File Uploads**: Choose upload directories dynamically.\n- **Initial Setup**: First-time setup prompts for admin account creation.\n- **Integrated Search**: Real-time search filtering of articles on the homepage and article list pages.\n- **Export Functionality**: Export all published articles as Markdown files in a zipped archive.\n\n### Contributing\n\nFeel free to contribute by submitting issues, feature requests, or pull requests.\n\n### Running in Production\n\nUsing [Gunicorn](https://gunicorn.org/) or [Daphne](https://github.com/django/daphne) with a server like Nginx is recommended for running Django applications in production.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthoth2357%2Fopenkb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthoth2357%2Fopenkb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthoth2357%2Fopenkb/lists"}