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].
label='Site UI Language',
section.columns
item-value='id',
.column.is-half
item-text='name',
p.control
persistent-hint,
label.label Server Port
hint='The language in which navigation, help and other UI elements will be displayed.'
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.',
v-validate='{ required: true }',
data-vv-name='port',
data-vv-as='Port',
data-vv-scope='general',
:error-messages='errors.collect(`port`)'
)
v-flex(xs12, sm8)
v-text-field(
v-model='conf.pathData',
label='Temporary Data Path',
persistent-hint,
hint='The path where temporary data is stored (cache, thumbnails, temporary upload files, etc.)',
v-validate='{ required: true, min: 2 }',
data-vv-name='pathData',
data-vv-as='Temporary Data Path',
data-vv-scope='general',
:error-messages='errors.collect(`pathData`)'
)
v-layout(row, wrap).mt-3
v-flex(xs12)
v-checkbox(
color='primary',
v-model='conf.public',
label='Public Access',
persistent-hint,
hint='Should the site be accessible (read only) without login.'
)
v-checkbox.mt-2(
color='primary',
v-model='conf.selfRegister',
label='Allow Self-Registration',
persistent-hint,
hint='Can users create their own account to gain access?'
)
v-divider
.text-xs-center
v-btn(@click='proceedToSyscheck', :disabled='loading') Back
.body-2 A root administrator account will be created for local authentication. From this account, you can create or authorize more users.
.panel-content.is-text
v-form
.is-logo
v-container
svg.icons.is-64: use(xlink:href='#nc-radar')
v-layout(row, wrap)
h4 Important Considerations
v-flex(xs12)
h3 Is Wiki.js going to be behind a web server (e.g. nginx / apache / IIS) or proxy?
v-text-field(
p
autofocus
ul
v-model='conf.adminEmail',
li - Make sure the upload limit is sufficient. Most web servers have a low limit (e.g. 2 MB) by default.
label='Administrator Email',
li - Do not rewrite URLs after the domain. This can cause unexpected issues in Wiki.js navigation.
hint='The email address of the administrator account',
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-validate='{ required: true, email: true }',
template(v-if='considerations.https')
data-vv-name='adminEmail',
h3 The site will not be using HTTPS? #[svg.icons.is-20.is-outlined.animated.fadeOut.infinite: use(xlink:href='#nc-alert')]
data-vv-as='Administrator Email',
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.
data-vv-scope='admin',
template(v-if='considerations.port')
:error-messages='errors.collect(`adminEmail`)'
h3 You are using a non-standard port.
)
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.
.body-2 Migrating from a Wiki.js 1.x installation is quick and simple.
.panel-content.is-text
v-form
.is-logo
v-container
img(src='svg/logo-git.svg', alt='Git Logo')
v-layout(row)
h4 Git Repository
v-flex(xs12)
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.
v-text-field(
.panel-content.form-sections
v-model='conf.upgMongo',
section.columns
placeholder='mongodb://',
.column.is-two-thirds
label='Connection String to Wiki.js 1.x MongoDB database',
p.control.is-fullwidth
persistent-hint,
label.label Repository URL
hint='A MongoDB database connection string where a Wiki.js 1.x installation is located. No alterations will be made to this database.',
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.
