SunsetERP.github.io/installation-guide.html at main · SunsetERP/SunsetERP.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en-US" data-preset="contrast" data-primary-color="#307FFF"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="robots" content="noindex"><meta name="built-on" content="2025-02-23T09:44:55.76843197"><title>Installation guide | Instance Name</title><script type="application/json" id="virtual-toc-data">[{"id":"introduction","level":0,"title":"Introduction","anchor":"#introduction"},{"id":"installation-types","level":0,"title":"Installation types","anchor":"#installation-types"},{"id":"overview","level":0,"title":"Overview","anchor":"#overview"},{"id":"system-requirements","level":0,"title":"System requirements","anchor":"#system-requirements"},{"id":"before-you-begin","level":0,"title":"Before you begin","anchor":"#before-you-begin"},{"id":"installation-steps","level":0,"title":"Installation steps","anchor":"#installation-steps"},{"id":"verify-installation","level":0,"title":"Verify installation","anchor":"#verify-installation"},{"id":"post-installation","level":0,"title":"Post installation","anchor":"#post-installation"},{"id":"troubleshooting","level":0,"title":"Troubleshooting","anchor":"#troubleshooting"},{"id":"next-steps","level":0,"title":"Next steps","anchor":"#next-steps"},{"id":"product-version-history","level":0,"title":"Product version history","anchor":"#product-version-history"},{"id":"definition-of-terms","level":0,"title":"Definition of terms","anchor":"#definition-of-terms"}]</script><script type="application/json" id="topic-shortcuts"></script><link href="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b575/app.css" rel="stylesheet"><meta name="msapplication-TileColor" content="#000000"><link rel="apple-touch-icon" sizes="180x180" href="https://jetbrains.com/apple-touch-icon.png"><link rel="icon" type="image/png" sizes="32x32" href="https://jetbrains.com/favicon-32x32.png"><link rel="icon" type="image/png" sizes="16x16" href="https://jetbrains.com/favicon-16x16.png"><meta name="msapplication-TileImage" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-144x144.png"><meta name="msapplication-square70x70logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-70x70.png"><meta name="msapplication-square150x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-150x150.png"><meta name="msapplication-wide310x150logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x150.png"><meta name="msapplication-square310x310logo" content="https://resources.jetbrains.com/storage/ui/favicons/mstile-310x310.png"><meta name="image" content=""><!-- Open Graph --><meta property="og:title" content="Installation guide | Instance Name"><meta property="og:description" content=""><meta property="og:image" content=""><meta property="og:site_name" content="Instance Name Help"><meta property="og:type" content="website"><meta property="og:locale" content="en_US"><meta property="og:url" content="writerside-documentation/installation-guide.html"><!-- End Open Graph --><!-- Twitter Card --><meta name="twitter:card" content="summary_large_image"><meta name="twitter:site" content=""><meta name="twitter:title" content="Installation guide | Instance Name"><meta name="twitter:description" content=""><meta name="twitter:creator" content=""><meta name="twitter:image:src" content=""><!-- End Twitter Card --><!-- Schema.org WebPage --><script type="application/ld+json">{
    "@context": "http://schema.org",
    "@type": "WebPage",
    "@id": "writerside-documentation/installation-guide.html#webpage",
    "url": "writerside-documentation/installation-guide.html",
    "name": "Installation guide | Instance Name",
    "description": "",
    "image": "",
    "inLanguage":"en-US"
}</script><!-- End Schema.org --><!-- Schema.org WebSite --><script type="application/ld+json">{
    "@type": "WebSite",
    "@id": "writerside-documentation/#website",
    "url": "writerside-documentation/",
    "name": "Instance Name Help"
}</script><!-- End Schema.org --></head><body data-id="Installation-guide" data-main-title="Installation guide" data-article-props="{&quot;seeAlsoStyle&quot;:&quot;links&quot;}" data-template="article" data-breadcrumbs=""><div class="wrapper"><main class="panel _main"><header class="panel__header"><div class="container"><h3>Instance Name  Help</h3><div class="panel-trigger"></div></div></header><section class="panel__content"><div class="container"><article class="article" data-shortcut-switcher="inactive"><h1 data-toc="Installation-guide" id="Installation-guide.md">Installation guide</h1><aside class="prompt" data-type="tip" data-title="" id="-rfiohk_3"><p id="-rfiohk_16">If you need more information about how to fill in this template, read the accompanying <a href="https://gitlab.com/tgdp/templates/-/blob/v1.2.0/installation-guide/guide_installation-guide.md" id="-rfiohk_18" data-external="true" rel="noopener noreferrer">guide</a>.</p><p id="-rfiohk_17">This template includes writing instructions and boilerplate text that you can customize, use as-is, or completely replace with your own text. This text is indicated in {(curly brackets)}. Make sure you replace the placeholders with your own text.</p></aside><section class="chapter"><h2 id="introduction" data-toc="introduction">Introduction</h2><p id="-rfiohk_19">{(The installation guide template includes information on writing procedures for successfully installing {product name)}. {(Insert your preferred description of the installation process.)}</p><p id="-rfiohk_20">{(Optional: Add a demo GIF that shows what the installed project would look like or link to a sandbox or playground to test out the product and explore its features.)}</p></section><section class="chapter"><h2 id="installation-types" data-toc="installation-types">Installation types</h2><p id="-rfiohk_21">This guide explains the steps and instructions required to install {(product name)} on supported operating systems. It also explains how to configure, start, and uninstall {(product name)}}.</p><p id="-rfiohk_22">{Include a table to capture the different installation types, such as:</p><ul class="list _bullet" id="-rfiohk_23"><li class="list__item" id="-rfiohk_25"><p>Supported operating systems</p></li><li class="list__item" id="-rfiohk_26"><p>The type of product installed (if provided in different versions, such as Main and Lite version)</p></li><li class="list__item" id="-rfiohk_27"><p>Cloud providers, such as CodeSpaces, CodeSandBox, GitPod, etc.,) including a link to the right heading for all options.}</p></li></ul><div class="table-wrapper"><table class="wide" id="-rfiohk_24"><thead><tr class="ijRowHead" id="-rfiohk_28"><th id="-rfiohk_31"><p><span class="control" id="-rfiohk_34">Type</span></p></th><th id="-rfiohk_32"><p><span class="control" id="-rfiohk_35">Description</span></p></th><th id="-rfiohk_33"><p><span class="control" id="-rfiohk_36">More information</span></p></th></tr></thead><tbody><tr id="-rfiohk_29"><td id="-rfiohk_37"><p>{(Name of installation type)}</p></td><td id="-rfiohk_38"><p>{(Description of installation type)}</p></td><td id="-rfiohk_39"><p>{(Link to the relevant installation steps section)}</p></td></tr><tr id="-rfiohk_30"><td id="-rfiohk_40"><p>{(Name of installation type)}</p></td><td id="-rfiohk_41"><p>{(Description of installation type)}</p></td><td id="-rfiohk_42"><p>{(Link to the relevant installation steps section)}</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="overview" data-toc="overview">Overview</h2><p id="-rfiohk_43">{(This section is optional.)}</p><p id="-rfiohk_44">{(Add a list of the available project versions, link to the installation guide for that version, and highlight the latest, beta, or stable version as listed in the following table:)}</p><div class="table-wrapper"><table class="wide" id="-rfiohk_45"><thead><tr class="ijRowHead" id="-rfiohk_49"><th id="-rfiohk_53"><p><span class="control" id="-rfiohk_57">Version</span></p></th><th id="-rfiohk_54"><p><span class="control" id="-rfiohk_58">Build</span></p></th><th id="-rfiohk_55"><p><span class="control" id="-rfiohk_59">Release Date</span></p></th><th id="-rfiohk_56"><p><span class="control" id="-rfiohk_60">Status</span></p></th></tr></thead><tbody><tr id="-rfiohk_50"><td id="-rfiohk_61"><p><span id="-rfiohk_65">V {(versionNumber)}</span></p></td><td id="-rfiohk_62"><p>{(versionNumber release)}</p></td><td id="-rfiohk_63"><p>{(dd/mm/yyyy)}</p></td><td id="-rfiohk_64"><p>{(Latest)}</p></td></tr><tr id="-rfiohk_51"><td id="-rfiohk_66"><p><span id="-rfiohk_70">V {(versionNumber)}</span></p></td><td id="-rfiohk_67"><p>{(versionNumber release)}</p></td><td id="-rfiohk_68"><p>{(dd/mm/yyyy)}</p></td><td id="-rfiohk_69"><p>{(Beta)}</p></td></tr><tr id="-rfiohk_52"><td id="-rfiohk_71"><p><span id="-rfiohk_75">V {(versionNumber)}</span></p></td><td id="-rfiohk_72"><p>{(versionNumber release)}</p></td><td id="-rfiohk_73"><p>{(dd/mm/yyyy)}</p></td><td id="-rfiohk_74"><p>{(Stable)}</p></td></tr></tbody></table></div><p id="-rfiohk_46">{(Explain the intended result of the installation, such as the commands, command aliases, major flags, available plugins, files downloaded, or application programs.)}</p><p id="-rfiohk_47">{(Add a sequential end-to-end summary of the installation process that can serve as a quick link or reference section for users as listed in the following table:)}</p><div class="table-wrapper"><table class="wide" id="-rfiohk_48"><thead><tr class="ijRowHead" id="-rfiohk_76"><th id="-rfiohk_81"></th><th id="-rfiohk_82"><p><span class="control" id="-rfiohk_84">Process</span></p></th><th id="-rfiohk_83"><p><span class="control" id="-rfiohk_85">More information</span></p></th></tr></thead><tbody><tr id="-rfiohk_77"><td id="-rfiohk_86"><p>1.</p></td><td id="-rfiohk_87"><p>Before installing, check the system requirements to ensure your computer is supported in the latest version of {(product name)}.</p></td><td id="-rfiohk_88"><p>{(Link to relevant documents)}</p></td></tr><tr id="-rfiohk_78"><td id="-rfiohk_89"><p>2.</p></td><td id="-rfiohk_90"><p>Check the system prerequisites to install all the required {(software, dependencies, tools.)}.</p></td><td id="-rfiohk_91"><p>{(Link to relevant documents)}</p></td></tr><tr id="-rfiohk_79"><td id="-rfiohk_92"><p>3.</p></td><td id="-rfiohk_93"><p>{(List additional steps.)}</p></td><td id="-rfiohk_94"><p>{(Link to relevant documents)}</p></td></tr><tr id="-rfiohk_80"><td id="-rfiohk_95"><p>4.</p></td><td id="-rfiohk_96"><p>Verify that the installation was successful.</p></td><td id="-rfiohk_97"><p>{(Link to relevant documents)}</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="system-requirements" data-toc="system-requirements">System requirements</h2><p id="-rfiohk_98">{(Start by breaking this into sub-sections based on the number of installation types (product type, operating system, or cloud-especially for projects that require self-hosting to work). Based on your use case, you can use this section reversely by having the installation type as the heading and system requirements for that type as a sub-section.)}</p><p id="-rfiohk_99">{(Mention for all installation types.)}</p></section><section class="chapter"><h2 id="before-you-begin" data-toc="before-you-begin">Before you begin</h2><p id="-rfiohk_100">{(List and highlight all the required prerequisites here. Consider making this a table.)}</p><p id="-rfiohk_101">Before installing {(version number)}, ensure you have:</p><ul class="list _bullet" id="-rfiohk_102"><li class="list__item" id="-rfiohk_105"><p>{(Prerequisite one)}</p></li><li class="list__item" id="-rfiohk_106"><p>{(Prerequisite two)}</p></li><li class="list__item" id="-rfiohk_107"><p>{(Prerequisite three)}</p></li></ul><p id="-rfiohk_103">{(Include prerequisites for all installation types.)}</p><div class="table-wrapper"><table class="wide" id="-rfiohk_104"><thead><tr class="ijRowHead" id="-rfiohk_108"><th id="-rfiohk_111"><p><span class="control" id="-rfiohk_114">Type</span></p></th><th id="-rfiohk_112"><p><span class="control" id="-rfiohk_115">Prerequisites</span></p></th><th id="-rfiohk_113"><p><span class="control" id="-rfiohk_116">Note(s)</span></p></th></tr></thead><tbody><tr id="-rfiohk_109"><td id="-rfiohk_117"><p>{(Installation type name)}</p></td><td id="-rfiohk_118"><p>{(Installation type prerequisites)}</p></td><td id="-rfiohk_119"><p>{(Important considerations)}</p></td></tr><tr id="-rfiohk_110"><td id="-rfiohk_120"><p>{(Installation type name)}</p></td><td id="-rfiohk_121"><p>{(Installation type prerequisites)}</p></td><td id="-rfiohk_122"><p>{(Important considerations)}</p></td></tr></tbody></table></div></section><section class="chapter"><h2 id="installation-steps" data-toc="installation-steps">Installation steps</h2><p id="-rfiohk_123">The following procedure explains how to install {(installation type name)} and {(optional version number)}.</p><p id="-rfiohk_124">{(Provide a short introduction to the step-by-step procedure based on the installation type.)}</p><p id="-rfiohk_125">Get started with {(version number)} by {(write the first step a user needs to start the installation. Use a verb to start.)}</p><section class="chapter"><h3 id="step-1-one-sentence-description-of-the-step" data-toc="step-1-one-sentence-description-of-the-step">Step 1 - One-sentence description of the step</h3><p id="-rfiohk_128">{(Optionally, introduce this section with brief explanatory text.)}</p><p id="-rfiohk_129">{(Continue with a list section if these steps include a sequence of instructions)}</p><p id="-rfiohk_130">{(Optional: include a code snippet or relevant screenshot that helps your users complete the steps.)}</p><p id="-rfiohk_131">{(Optional: show the result of completing this step, such as a text output or an image).)}</p><section class="chapter"><h4 id="1-1-substep-1-one-sentence-description-of-the-step" data-toc="1-1-substep-1-one-sentence-description-of-the-step">1.1. Substep 1 - One-sentence description of the step</h4><p id="-rfiohk_134">{(Optionally, introduce this section with brief explanatory text.)}</p><p id="-rfiohk_135">{(Continue with a list section if these steps include a sequence of instructions)}</p></section><section class="chapter"><h4 id="1-2-substep-2-one-sentence-description-of-the-step" data-toc="1-2-substep-2-one-sentence-description-of-the-step">1.2. Substep 2 - One-sentence description of the step</h4><p id="-rfiohk_136">{(Optionally, introduce this section with brief explanatory text.)}</p><p id="-rfiohk_137">{(Continue with a list section if these steps include a sequence of instructions.)}</p></section></section><section class="chapter"><h3 id="step-2-one-sentence-description-of-the-step" data-toc="step-2-one-sentence-description-of-the-step">Step 2 - One-sentence description of the step</h3><p id="-rfiohk_138">{(Optionally, introduce this section with brief explanatory text.)}</p><p id="-rfiohk_139">{(Continue with a list section if these steps include a sequence of instructions.)}</p></section></section><section class="chapter"><h2 id="verify-installation" data-toc="verify-installation">Verify installation</h2><p id="-rfiohk_140">{(Include test commands, intended outputs, or other steps to confirm the installation was successful.)}</p></section><section class="chapter"><h2 id="post-installation" data-toc="post-installation">Post installation</h2><p id="-rfiohk_141">{(Provide an overview of options or link to other relevant documentation once installation has been completed. Also, account for anticipated problems during or after installation.)}</p><p id="-rfiohk_142">{(Optinal: include short introduction text.)}</p><section class="chapter"><h3 id="configuration-options" data-toc="configuration-options">Configuration options</h3><p id="-rfiohk_147">{(Provide information regarding post-installation configuration options.)}</p><p id="-rfiohk_148">{(Describe the requirements for configuring the installed product.)}</p><p id="-rfiohk_149">{(Link to relevant documentation if needed.)}</p></section><section class="chapter"><h3 id="upgrade-options" data-toc="upgrade-options">Upgrade options</h3><p id="-rfiohk_150">{(Provide information regarding upgrade options, also known as an update options.)}</p><p id="-rfiohk_151">{(Describe how to install updates from a range of possible options.)}</p><p id="-rfiohk_152">{(Provide a link to available updates with specific version numbers, release dates, and key features.)}</p><p id="-rfiohk_153">Example: To begin the system updates:</p><ol class="list _decimal" id="-rfiohk_154" type="1"><li class="list__item" id="-rfiohk_155"><p>Choose the version number.</p></li><li class="list__item" id="-rfiohk_156"><p>Download the update at <a href="http://example.com" id="-rfiohk_159" data-external="true" rel="noopener noreferrer">link</a>.</p></li><li class="list__item" id="-rfiohk_157"><p>Double-click the update file.</p></li><li class="list__item" id="-rfiohk_158"><p>Additional steps as needed.</p></li></ol></section><section class="chapter"><h3 id="downgrade-options" data-toc="downgrade-options">Downgrade options</h3><p id="-rfiohk_160">{(Provide information regarding downgrading the version installed.)}</p></section><section class="chapter"><h3 id="uninstallation-options" data-toc="uninstallation-options">Uninstallation options</h3><p id="-rfiohk_161">{(Provide information regarding uninstalling the product, software, SDK, package, library, framework installed.)}</p></section></section><section class="chapter"><h2 id="troubleshooting" data-toc="troubleshooting">Troubleshooting</h2><p id="-rfiohk_162">{(This section helps solve problems encountered during installation. Start with a problem statement, then indicate the cause(s) and provide a solution. Additional information can be added (e.g., restart the computer))}.</p><p id="-rfiohk_163">{Add a warning note and highlight in color if the action has the potential to affect security.</p><p id="-rfiohk_164">Communicating with the product engineers and programmers is essential to keep this section up-to-date.}</p><section class="chapter"><h3 id="problem-title" data-toc="problem-title">{(Problem title: ...)}</h3><p id="-rfiohk_167">{(Optional: More details about the <span class="control" id="-rfiohk_171">problem</span>.)}</p><p id="-rfiohk_168">{(Optional: More details about the <span class="control" id="-rfiohk_172">cause(s)</span> of the problem.)}</p><p id="-rfiohk_169"><span class="control" id="-rfiohk_173">Solution</span>: {(Solution to the problem...)}</p><p id="-rfiohk_170"><span class="control" id="-rfiohk_174">Contact</span>: {(Support/contact information for issue reports and feedback...)}</p></section><section class="chapter"><h3 id="problem-title" data-toc="problem-title">{(Problem title: ...)}</h3><p id="-rfiohk_175">...</p></section></section><section class="chapter"><h2 id="next-steps" data-toc="next-steps">Next steps</h2><p id="-rfiohk_176">{(Include what to do after a successful installation, such as a recommended next step or links to further recommended documentation.)}</p></section><section class="chapter"><h2 id="product-version-history" data-toc="product-version-history">Product version history</h2><p id="-rfiohk_177">{(History section with major changes to the installation guide tabulated following the Major.Minor.Patch semantic versioning specification.)}</p></section><section class="chapter"><h2 id="definition-of-terms" data-toc="definition-of-terms">Definition of terms</h2><p id="-rfiohk_178">{(Optional: Provide a glossary table describing the terms, acronyms, and abbreviations used in the installation guide.)}</p><div class="table-wrapper"><table class="wide" id="-rfiohk_179"><thead><tr class="ijRowHead" id="-rfiohk_182"><th id="-rfiohk_185"><p><span class="control" id="-rfiohk_187">Term</span></p></th><th id="-rfiohk_186"><p><span class="control" id="-rfiohk_188">Meaning</span></p></th></tr></thead><tbody><tr id="-rfiohk_183"><td id="-rfiohk_189"><p>{(Term, acronym, or abbreviation)}</p></td><td id="-rfiohk_190"><p>{(Provide a definition of the term or acronym or abbreviation used in this guide.)}</p></td></tr><tr id="-rfiohk_184"><td id="-rfiohk_191"><p>{(Term, acronym, or abbreviation)}</p></td><td id="-rfiohk_192"><p>{(Provide a definition of the term or acronym or abbreviation used in this guide.)}</p></td></tr></tbody></table></div><aside class="prompt" data-type="tip" data-title="" id="-rfiohk_181"><p id="-rfiohk_193">Explore other templates from <a href="https://thegooddocsproject.dev/" id="-rfiohk_194" data-external="true" rel="noopener noreferrer">The Good Docs Project</a>. Use our <a href="https://thegooddocsproject.dev/feedback/?template=Installation%20guide" id="-rfiohk_195" data-external="true" rel="noopener noreferrer">feedback form</a> to give feedback on this template.</p></aside></section><div class="last-modified">Last modified: 23 February 2025</div><div data-feedback-placeholder="true"></div><div class="navigation-links _bottom"><a href="starter.html" class="navigation-links__prev">Starter</a></div></article><div id="disqus_thread"></div></div></section></main></div><script src="https://resources.jetbrains.com/writerside/apidoc/6.10.0-b575/app.js"></script></body></html>