You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

146 lines
8.3 KiB

  1. doctype html
  2. html
  3. head
  4. meta(http-equiv='X-UA-Compatible', content='IE=edge')
  5. meta(charset='UTF-8')
  6. title Wiki.js | Configure
  7. // Favicon
  8. each favsize in [32, 96, 16]
  9. link(rel='icon', type='image/png', sizes=favsize + 'x' + favsize, href='/favicons/favicon-' + favsize + 'x' + favsize + '.png')
  10. // CSS
  11. link(type='text/css', rel='stylesheet', href='/css/libs.css')
  12. link(type='text/css', rel='stylesheet', href='/css/configure.css')
  13. // JS
  14. script(type='text/javascript', src='/js/libs.js')
  15. script(type='text/javascript', src='/js/configure.js')
  16. block head
  17. body
  18. #root
  19. #header-container
  20. nav.nav#header
  21. .nav-left
  22. a.nav-item
  23. h1
  24. i.icon-layers
  25. | Wiki.js
  26. main
  27. .container
  28. transition(name='tst-welcome')
  29. .welcome(style={'padding-bottom': '5px'}, v-if='state === "welcome"')
  30. img(src='/favicons/android-icon-96x96.png', alt='Wiki.js')
  31. h1 Welcome to Wiki.js!
  32. h2(style={'margin-bottom': 0}) A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
  33. .content(v-cloak)
  34. template(v-if='state === "welcome"')
  35. .panel
  36. h2.panel-title.is-featured
  37. span Introduction
  38. i(v-if='loading')
  39. .panel-content.is-text
  40. p This installation wizard will guide you through the steps needed to get your wiki up and running in no time!
  41. p Detailed information about installation and usage can be found on the #[a(href='https://docs.wiki.requarks.io/') 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].
  42. .panel-footer
  43. button.button.is-indigo(v-on:click='proceedToSyscheck', v-bind:disabled='loading') Start
  44. template(v-else-if='state === "syscheck"')
  45. .panel
  46. h2.panel-title.is-featured
  47. span System Check
  48. i(v-if='loading')
  49. .panel-content.is-text
  50. p(v-if='loading') #[i.icon-loader.animated.rotateIn.infinite] Checking your system for compatibility...
  51. p(v-if='!loading && syscheck.ok')
  52. ul
  53. li(v-for='rs in syscheck.results') #[i.icon-check] {{rs}}
  54. p(v-if='!loading && syscheck.ok')
  55. i.icon-check
  56. strong Looks good! No issues so far.
  57. p(v-if='!loading && !syscheck.ok') #[i.icon-square-cross] Error: {{ syscheck.error }}
  58. .panel-footer
  59. button.button.is-indigo.is-outlined(v-on:click='proceedToWelcome', v-bind:disabled='loading') Back
  60. button.button.is-teal(v-on:click='proceedToSyscheck', v-if='!loading && !syscheck.ok') Check Again
  61. button.button.is-indigo(v-on:click='proceedToGeneral', v-if='loading || syscheck.ok', v-bind:disabled='loading') Continue
  62. template(v-else-if='state === "general"')
  63. .panel
  64. h2.panel-title.is-featured
  65. span General
  66. i(v-if='loading')
  67. .panel-content.form-sections
  68. section
  69. p.control.is-fullwidth
  70. label.label Site Title
  71. input(type='text', placeholder='e.g. Wiki', v-model='conf.title')
  72. p.desc The site title will appear in the top left corner on every page and within the window title bar.
  73. section
  74. p.control.is-fullwidth
  75. label.label Host
  76. input(type='text', placeholder='http://', v-model='conf.host')
  77. p.desc The full URL to your wiki, without the trailing slash. E.g.: http://wiki.domain.com. Note that sub-folders are not supported.
  78. section
  79. p.control
  80. label.label Port
  81. input(type='text', placeholder='e.g. 80', v-model='conf.port')
  82. p.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.
  83. section
  84. p.control
  85. label.label Site UI Language
  86. select(v-model='conf.lang')
  87. option(value='en') English
  88. p.desc The language in which navigation, help and other UI elements will be displayed.
  89. .panel-footer
  90. button.button.is-indigo.is-outlined(v-on:click='proceedToSyscheck', v-bind:disabled='loading') Back
  91. button.button.is-indigo(v-on:click='proceedToConsiderations', v-bind:disabled='loading') Continue
  92. template(v-else-if='state === "considerations"')
  93. .panel
  94. h2.panel-title.is-featured
  95. span Important Considerations
  96. i(v-if='loading')
  97. .panel-content.is-text
  98. h3 Is Wiki.js going to be behind a web server (e.g. nginx / apache / IIS) or proxy?
  99. p
  100. ul
  101. li - Make sure the upload limit is sufficient. Most web servers have a low limit (e.g. 2 MB) by default.
  102. li - Make sure your web server is configured to allow web sockets. Wiki.js will fallback to standard XHR queries if not available.
  103. li - Do not rewrite URLs after the domain. This can cause unexpected issues in Wiki.js navigation.
  104. li - Do not remove or alter the client IP when proxying the requests. This can cause the authentication brute force protection to engage unexpectedly.
  105. template(v-if='considerations.https')
  106. h3 The site will not be using HTTPS? #[i.icon-warning-outline.animated.fadeOut.infinite]
  107. 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.
  108. template(v-if='considerations.port')
  109. h3 You are using a non-standard port.
  110. 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.
  111. template(v-if='considerations.localhost')
  112. h3 Are you sure you want to use localhost as the host base URL? #[i.icon-warning-outline.animated.fadeOut.infinite]
  113. p The host URL you specified is localhost. Unless you are a developer running Wiki.js locally on your machine, this is not recommended!
  114. .panel-footer
  115. button.button.is-indigo.is-outlined(v-on:click='proceedToGeneral', v-bind:disabled='loading') Back
  116. button.button.is-indigo(v-on:click='proceedToDb', v-bind:disabled='loading') Continue
  117. template(v-else-if='state === "db"')
  118. .panel
  119. h2.panel-title.is-featured
  120. span Database
  121. i(v-if='loading')
  122. .panel-content.form-sections
  123. section
  124. p.control.is-fullwidth
  125. label.label MongoDB Connection String
  126. input(type='text', placeholder='e.g. mongodb://localhost:27017/wiki', v-model='conf.db')
  127. p.desc The connection string to your MongoDB server. Leave the default localhost value if MongoDB is installed on the same server.
  128. .panel-footer
  129. button.button.is-indigo.is-outlined(v-on:click='proceedToConsiderations', v-bind:disabled='loading') Back
  130. button.button.is-indigo(v-on:click='proceedToSyscheck', v-bind:disabled='loading') Connect
  131. footer.footer
  132. span
  133. | Powered by
  134. a(href='https://github.com/Requarks/wiki') Wiki.js
  135. | .
  136. block outside