h2 A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
| Should you have any question or would like to report something that doesn't look right, feel free to create a new issue on the #[a(href='https://github.com/Requarks/wiki/issues') GitHub project].
p This installation wizard will guide you through the steps needed to get your wiki up and running in no time!
.body-1.pt-3
p Detailed information about installation and usage can be found on the #[a(href='https://wiki.requarks.io/docs') official documentation site]. #[br] Should you have any question or would like to report something that doesn't look right, feel free to create a new issue on the #[a(href='https://github.com/Requarks/wiki/issues') GitHub project].
span.desc The relative path to your wiki. Unless you configure a reverse proxy in front of Wiki.js to handle requests made to a sub-directory, #[strong it is recommended to leave the default value].
span.desc The port on which Wiki.js will listen to. Usually port 80 if connecting directly, or a random port (e.g. 3000) if using a web server in front of it. Set #[strong $(PORT)] to use the PORT environment variable.
span.desc The path where the local git repository will be created, used to store content in markdown files and uploads.#[br] #[strong It is recommended to leave the default value].
hint='The port on which Wiki.js will listen to. Usually port 80 if connecting directly, or a random port (e.g. 3000) if using a web server in front of it. Set $(PORT) to use the PORT environment variable.',
svg.icons.is-64: use(xlink:href='#nc-radar')
v-validate='{ required: true }',
h4 Important Considerations
data-vv-name='port',
h3 Is Wiki.js going to be behind a web server (e.g. nginx / apache / IIS) or proxy?
data-vv-as='Port',
p
data-vv-scope='general',
ul
:error-messages='errors.collect(`port`)'
li - Make sure the upload limit is sufficient. Most web servers have a low limit (e.g. 2 MB) by default.
)
li - Do not rewrite URLs after the domain. This can cause unexpected issues in Wiki.js navigation.
v-flex(xs12, sm8)
li - Do not remove or alter the client IP when proxying the requests. This can cause the authentication brute force protection to engage unexpectedly.
v-text-field(
template(v-if='considerations.https')
v-model='conf.pathData',
h3 The site will not be using HTTPS? #[svg.icons.is-20.is-outlined.animated.fadeOut.infinite: use(xlink:href='#nc-alert')]
label='Temporary Data Path',
p The host URL you specified is not HTTPS. It is highly recommended to use HTTPS. You must use a web server / proxy (e.g. nginx / apache / IIS) in front of Wiki.js to use HTTPS. Wiki.js does not provide HTTPS handling by itself.
persistent-hint,
template(v-if='considerations.port')
hint='The path where temporary data is stored (cache, thumbnails, temporary upload files, etc.)',
h3 You are using a non-standard port.
v-validate='{ required: true, min: 2 }',
p If you are not planning on using a web server / proxy in front of Wiki.js, be aware that users will need to specify the port when accessing the wiki. Make sure this is the intended behavior. Otherwise set a standard HTTP port such as 80.
hint='Should the site be accessible (read only) without login.'
span Wiki.js
)
i(v-if='loading')
v-checkbox.mt-2(
.panel-content.is-text
color='primary',
.is-logo
v-model='conf.selfRegister',
img(src='svg/logo-git.svg', alt='Git Logo')
label='Allow Self-Registration',
h4 Git Repository
persistent-hint,
p Wiki.js stores article content and uploads locally on disk. All content is then regularly kept in sync with a remote git repository. This acts a backup protection and provides history / revert features. While optional, it is <strong>HIGHLY</strong> recommended to setup the remote git repository connection.
hint='Can users create their own account to gain access?'
.panel-content.form-sections
)
section.columns
v-divider
.column.is-two-thirds
.text-xs-center
p.control.is-fullwidth
v-btn(@click='proceedToSyscheck', :disabled='loading') Back
label.label(for='ipt-git-show-user-email') Commit using User Email
span.desc When enabled, commits are made as the current user name and email. If unchecked, the current user name will still be used but the default commit author email will be used instead.
