3.0.0.mjs 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806
  1. import { v4 as uuid } from 'uuid'
  2. import bcrypt from 'bcryptjs'
  3. import crypto from 'node:crypto'
  4. import { DateTime } from 'luxon'
  5. import { pem2jwk } from 'pem-jwk'
  6. export async function up (knex) {
  7. WIKI.logger.info('Running 3.0.0 database migration...')
  8. // =====================================
  9. // PG EXTENSIONS
  10. // =====================================
  11. await knex.raw('CREATE EXTENSION IF NOT EXISTS ltree;')
  12. await knex.raw('CREATE EXTENSION IF NOT EXISTS pgcrypto;')
  13. await knex.raw('CREATE EXTENSION IF NOT EXISTS pg_trgm;')
  14. await knex.schema
  15. // =====================================
  16. // MODEL TABLES
  17. // =====================================
  18. // ACTIVITY LOGS -----------------------
  19. .createTable('activityLogs', table => {
  20. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  21. table.timestamp('ts').notNullable().defaultTo(knex.fn.now())
  22. table.string('action').notNullable()
  23. table.jsonb('meta').notNullable()
  24. })
  25. // ANALYTICS ---------------------------
  26. .createTable('analytics', table => {
  27. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  28. table.string('module').notNullable()
  29. table.boolean('isEnabled').notNullable().defaultTo(false)
  30. table.jsonb('config').notNullable()
  31. })
  32. // API KEYS ----------------------------
  33. .createTable('apiKeys', table => {
  34. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  35. table.string('name').notNullable()
  36. table.text('key').notNullable()
  37. table.timestamp('expiration').notNullable().defaultTo(knex.fn.now())
  38. table.boolean('isRevoked').notNullable().defaultTo(false)
  39. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  40. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  41. })
  42. // ASSETS ------------------------------
  43. .createTable('assets', table => {
  44. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  45. table.string('fileName').notNullable()
  46. table.string('fileExt').notNullable()
  47. table.boolean('isSystem').notNullable().defaultTo(false)
  48. table.enum('kind', ['document', 'image', 'other']).notNullable().defaultTo('other')
  49. table.string('mimeType').notNullable().defaultTo('application/octet-stream')
  50. table.integer('fileSize').unsigned().comment('In bytes')
  51. table.jsonb('meta').notNullable().defaultTo('{}')
  52. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  53. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  54. table.binary('data')
  55. table.binary('preview')
  56. table.enum('previewState', ['none', 'pending', 'ready', 'failed']).notNullable().defaultTo('none')
  57. table.jsonb('storageInfo')
  58. })
  59. // AUTHENTICATION ----------------------
  60. .createTable('authentication', table => {
  61. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  62. table.string('module').notNullable()
  63. table.boolean('isEnabled').notNullable().defaultTo(false)
  64. table.string('displayName').notNullable().defaultTo('')
  65. table.jsonb('config').notNullable().defaultTo('{}')
  66. table.boolean('selfRegistration').notNullable().defaultTo(false)
  67. table.jsonb('domainWhitelist').notNullable().defaultTo('[]')
  68. table.jsonb('autoEnrollGroups').notNullable().defaultTo('[]')
  69. })
  70. .createTable('commentProviders', table => {
  71. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  72. table.string('module').notNullable()
  73. table.boolean('isEnabled').notNullable().defaultTo(false)
  74. table.json('config').notNullable()
  75. })
  76. // COMMENTS ----------------------------
  77. .createTable('comments', table => {
  78. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  79. table.uuid('replyTo')
  80. table.text('content').notNullable()
  81. table.text('render').notNullable().defaultTo('')
  82. table.string('name').notNullable().defaultTo('')
  83. table.string('email').notNullable().defaultTo('')
  84. table.string('ip').notNullable().defaultTo('')
  85. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  86. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  87. })
  88. // GROUPS ------------------------------
  89. .createTable('groups', table => {
  90. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  91. table.string('name').notNullable()
  92. table.jsonb('permissions').notNullable()
  93. table.jsonb('rules').notNullable()
  94. table.string('redirectOnLogin').notNullable().defaultTo('')
  95. table.string('redirectOnFirstLogin').notNullable().defaultTo('')
  96. table.string('redirectOnLogout').notNullable().defaultTo('')
  97. table.boolean('isSystem').notNullable().defaultTo(false)
  98. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  99. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  100. })
  101. // HOOKS -------------------------------
  102. .createTable('hooks', table => {
  103. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  104. table.string('name').notNullable()
  105. table.jsonb('events').notNullable().defaultTo('[]')
  106. table.string('url').notNullable()
  107. table.boolean('includeMetadata').notNullable().defaultTo(false)
  108. table.boolean('includeContent').notNullable().defaultTo(false)
  109. table.boolean('acceptUntrusted').notNullable().defaultTo(false)
  110. table.string('authHeader')
  111. table.enum('state', ['pending', 'error', 'success']).notNullable().defaultTo('pending')
  112. table.string('lastErrorMessage')
  113. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  114. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  115. })
  116. // JOB HISTORY -------------------------
  117. .createTable('jobHistory', table => {
  118. table.uuid('id').notNullable().primary()
  119. table.string('task').notNullable()
  120. table.enum('state', ['active', 'completed', 'failed', 'interrupted']).notNullable()
  121. table.boolean('useWorker').notNullable().defaultTo(false)
  122. table.boolean('wasScheduled').notNullable().defaultTo(false)
  123. table.jsonb('payload')
  124. table.integer('attempt').notNullable().defaultTo(1)
  125. table.integer('maxRetries').notNullable().defaultTo(0)
  126. table.text('lastErrorMessage')
  127. table.string('executedBy')
  128. table.timestamp('createdAt').notNullable()
  129. table.timestamp('startedAt').notNullable().defaultTo(knex.fn.now())
  130. table.timestamp('completedAt')
  131. })
  132. // JOB SCHEDULE ------------------------
  133. .createTable('jobSchedule', table => {
  134. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  135. table.string('task').notNullable()
  136. table.string('cron').notNullable()
  137. table.string('type').notNullable().defaultTo('system')
  138. table.jsonb('payload')
  139. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  140. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  141. })
  142. // JOB SCHEDULE ------------------------
  143. .createTable('jobLock', table => {
  144. table.string('key').notNullable().primary()
  145. table.string('lastCheckedBy')
  146. table.timestamp('lastCheckedAt').notNullable().defaultTo(knex.fn.now())
  147. })
  148. // JOBS --------------------------------
  149. .createTable('jobs', table => {
  150. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  151. table.string('task').notNullable()
  152. table.boolean('useWorker').notNullable().defaultTo(false)
  153. table.jsonb('payload')
  154. table.integer('retries').notNullable().defaultTo(0)
  155. table.integer('maxRetries').notNullable().defaultTo(0)
  156. table.timestamp('waitUntil')
  157. table.boolean('isScheduled').notNullable().defaultTo(false)
  158. table.string('createdBy')
  159. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  160. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  161. })
  162. // LOCALES -----------------------------
  163. .createTable('locales', table => {
  164. table.string('code', 10).notNullable().primary()
  165. table.string('name').notNullable()
  166. table.string('nativeName').notNullable()
  167. table.string('language', 2).notNullable().index()
  168. table.string('region', 2)
  169. table.string('script', 4)
  170. table.boolean('isRTL').notNullable().defaultTo(false)
  171. table.jsonb('strings')
  172. table.integer('completeness').notNullable().defaultTo(0)
  173. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  174. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  175. })
  176. // NAVIGATION ----------------------------
  177. .createTable('navigation', table => {
  178. table.string('key').notNullable().primary()
  179. table.jsonb('config')
  180. })
  181. // PAGE HISTORY ------------------------
  182. .createTable('pageHistory', table => {
  183. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  184. table.uuid('pageId').notNullable().index()
  185. table.string('action').defaultTo('updated')
  186. table.jsonb('affectedFields').notNullable().defaultTo('[]')
  187. table.string('path').notNullable()
  188. table.string('hash').notNullable()
  189. table.string('alias')
  190. table.string('title').notNullable()
  191. table.string('description')
  192. table.string('icon')
  193. table.enu('publishState', ['draft', 'published', 'scheduled']).notNullable().defaultTo('draft')
  194. table.timestamp('publishStartDate')
  195. table.timestamp('publishEndDate')
  196. table.jsonb('config').notNullable().defaultTo('{}')
  197. table.jsonb('relations').notNullable().defaultTo('[]')
  198. table.text('content')
  199. table.text('render')
  200. table.jsonb('toc')
  201. table.string('editor').notNullable()
  202. table.string('contentType').notNullable()
  203. table.jsonb('scripts').notNullable().defaultTo('{}')
  204. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  205. table.timestamp('versionDate').notNullable().defaultTo(knex.fn.now())
  206. })
  207. // PAGE LINKS --------------------------
  208. .createTable('pageLinks', table => {
  209. table.increments('id').primary()
  210. table.string('path').notNullable()
  211. table.string('localeCode', 10).notNullable()
  212. })
  213. // PAGES -------------------------------
  214. .createTable('pages', table => {
  215. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  216. table.string('path').notNullable()
  217. table.string('hash').notNullable()
  218. table.string('alias')
  219. table.string('title').notNullable()
  220. table.string('description')
  221. table.string('icon')
  222. table.enu('publishState', ['draft', 'published', 'scheduled']).notNullable().defaultTo('draft')
  223. table.timestamp('publishStartDate')
  224. table.timestamp('publishEndDate')
  225. table.jsonb('config').notNullable().defaultTo('{}')
  226. table.jsonb('relations').notNullable().defaultTo('[]')
  227. table.text('content')
  228. table.text('render')
  229. table.text('searchContent')
  230. table.specificType('ts', 'tsvector').index('ts_idx', { indexType: 'GIN' })
  231. table.specificType('tags', 'text[]').index('tags_idx', { indexType: 'GIN' })
  232. table.jsonb('toc')
  233. table.string('editor').notNullable()
  234. table.string('contentType').notNullable()
  235. table.boolean('isBrowsable').notNullable().defaultTo(true)
  236. table.boolean('isSearchable').notNullable().defaultTo(true)
  237. table.specificType('isSearchableComputed', `boolean GENERATED ALWAYS AS ("publishState" != 'draft' AND "isSearchable") STORED`).index()
  238. table.string('password')
  239. table.integer('ratingScore').notNullable().defaultTo(0)
  240. table.integer('ratingCount').notNullable().defaultTo(0)
  241. table.jsonb('scripts').notNullable().defaultTo('{}')
  242. table.jsonb('historyData').notNullable().defaultTo('{}')
  243. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  244. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  245. })
  246. // RENDERERS ---------------------------
  247. .createTable('renderers', table => {
  248. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  249. table.string('module').notNullable()
  250. table.boolean('isEnabled').notNullable().defaultTo(false)
  251. table.jsonb('config').notNullable().defaultTo('{}')
  252. })
  253. // SETTINGS ----------------------------
  254. .createTable('settings', table => {
  255. table.string('key').notNullable().primary()
  256. table.jsonb('value')
  257. })
  258. // SITES -------------------------------
  259. .createTable('sites', table => {
  260. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  261. table.string('hostname').notNullable()
  262. table.boolean('isEnabled').notNullable().defaultTo(false)
  263. table.jsonb('config').notNullable()
  264. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  265. })
  266. // STORAGE -----------------------------
  267. .createTable('storage', table => {
  268. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  269. table.string('module').notNullable()
  270. table.boolean('isEnabled').notNullable().defaultTo(false)
  271. table.jsonb('contentTypes')
  272. table.jsonb('assetDelivery')
  273. table.jsonb('versioning')
  274. table.jsonb('schedule')
  275. table.jsonb('config')
  276. table.jsonb('state')
  277. })
  278. // TAGS --------------------------------
  279. .createTable('tags', table => {
  280. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  281. table.string('tag').notNullable()
  282. table.integer('usageCount').notNullable().defaultTo(0)
  283. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  284. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  285. })
  286. // TREE --------------------------------
  287. .createTable('tree', table => {
  288. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  289. table.specificType('folderPath', 'ltree').index().index('tree_folderpath_gist_index', { indexType: 'GIST' })
  290. table.string('fileName').notNullable().index()
  291. table.string('hash').notNullable().index()
  292. table.enu('type', ['folder', 'page', 'asset']).notNullable().index()
  293. table.string('localeCode', 10).notNullable().defaultTo('en').index()
  294. table.string('title').notNullable()
  295. table.jsonb('meta').notNullable().defaultTo('{}')
  296. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  297. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  298. })
  299. // USER AVATARS ------------------------
  300. .createTable('userAvatars', table => {
  301. table.uuid('id').notNullable().primary()
  302. table.binary('data').notNullable()
  303. })
  304. // USER EDITOR SETTINGS ----------------
  305. .createTable('userEditorSettings', table => {
  306. table.uuid('id').notNullable()
  307. table.string('editor').notNullable()
  308. table.jsonb('config').notNullable().defaultTo('{}')
  309. table.primary(['id', 'editor'])
  310. })
  311. // USER KEYS ---------------------------
  312. .createTable('userKeys', table => {
  313. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  314. table.string('kind').notNullable()
  315. table.string('token').notNullable()
  316. table.jsonb('meta').notNullable().defaultTo('{}')
  317. table.timestamp('validUntil').notNullable()
  318. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  319. })
  320. // USERS -------------------------------
  321. .createTable('users', table => {
  322. table.uuid('id').notNullable().primary().defaultTo(knex.raw('gen_random_uuid()'))
  323. table.string('email').notNullable()
  324. table.string('name').notNullable()
  325. table.jsonb('auth').notNullable().defaultTo('{}')
  326. table.jsonb('meta').notNullable().defaultTo('{}')
  327. table.jsonb('prefs').notNullable().defaultTo('{}')
  328. table.boolean('hasAvatar').notNullable().defaultTo(false)
  329. table.boolean('isSystem').notNullable().defaultTo(false)
  330. table.boolean('isActive').notNullable().defaultTo(false)
  331. table.boolean('isVerified').notNullable().defaultTo(false)
  332. table.timestamp('lastLoginAt').index()
  333. table.timestamp('createdAt').notNullable().defaultTo(knex.fn.now())
  334. table.timestamp('updatedAt').notNullable().defaultTo(knex.fn.now())
  335. })
  336. // =====================================
  337. // RELATION TABLES
  338. // =====================================
  339. // USER GROUPS -------------------------
  340. .createTable('userGroups', table => {
  341. table.increments('id').primary()
  342. table.uuid('userId').references('id').inTable('users').onDelete('CASCADE')
  343. table.uuid('groupId').references('id').inTable('groups').onDelete('CASCADE')
  344. })
  345. // =====================================
  346. // REFERENCES
  347. // =====================================
  348. .table('activityLogs', table => {
  349. table.uuid('userId').notNullable().references('id').inTable('users')
  350. })
  351. .table('analytics', table => {
  352. table.uuid('siteId').notNullable().references('id').inTable('sites')
  353. })
  354. .table('assets', table => {
  355. table.uuid('authorId').notNullable().references('id').inTable('users')
  356. table.uuid('siteId').notNullable().references('id').inTable('sites').index()
  357. })
  358. .table('commentProviders', table => {
  359. table.uuid('siteId').notNullable().references('id').inTable('sites')
  360. })
  361. .table('comments', table => {
  362. table.uuid('pageId').notNullable().references('id').inTable('pages').index()
  363. table.uuid('authorId').notNullable().references('id').inTable('users').index()
  364. })
  365. .table('navigation', table => {
  366. table.uuid('siteId').notNullable().references('id').inTable('sites').index()
  367. })
  368. .table('pageHistory', table => {
  369. table.string('localeCode', 10).references('code').inTable('locales')
  370. table.uuid('authorId').notNullable().references('id').inTable('users')
  371. table.uuid('siteId').notNullable().references('id').inTable('sites').index()
  372. })
  373. .table('pageLinks', table => {
  374. table.uuid('pageId').notNullable().references('id').inTable('pages').onDelete('CASCADE')
  375. table.index(['path', 'localeCode'])
  376. })
  377. .table('pages', table => {
  378. table.string('localeCode', 10).references('code').inTable('locales').index()
  379. table.uuid('authorId').notNullable().references('id').inTable('users').index()
  380. table.uuid('creatorId').notNullable().references('id').inTable('users').index()
  381. table.uuid('ownerId').notNullable().references('id').inTable('users').index()
  382. table.uuid('siteId').notNullable().references('id').inTable('sites').index()
  383. })
  384. .table('storage', table => {
  385. table.uuid('siteId').notNullable().references('id').inTable('sites')
  386. })
  387. .table('tags', table => {
  388. table.uuid('siteId').notNullable().references('id').inTable('sites')
  389. table.unique(['siteId', 'tag'])
  390. })
  391. .table('tree', table => {
  392. table.uuid('siteId').notNullable().references('id').inTable('sites')
  393. })
  394. .table('userKeys', table => {
  395. table.uuid('userId').notNullable().references('id').inTable('users')
  396. })
  397. // =====================================
  398. // TS WORD SUGGESTION TABLE
  399. // =====================================
  400. .createTable('autocomplete', table => {
  401. table.text('word')
  402. })
  403. .raw(`CREATE INDEX "autocomplete_idx" ON "autocomplete" USING GIN (word gin_trgm_ops)`)
  404. // =====================================
  405. // DEFAULT DATA
  406. // =====================================
  407. // -> GENERATE IDS
  408. const groupAdminId = uuid()
  409. const groupGuestId = '10000000-0000-4000-8000-000000000001'
  410. const siteId = uuid()
  411. const authModuleId = uuid()
  412. const userAdminId = uuid()
  413. const userGuestId = uuid()
  414. // -> SYSTEM CONFIG
  415. WIKI.logger.info('Generating certificates...')
  416. const secret = crypto.randomBytes(32).toString('hex')
  417. const certs = crypto.generateKeyPairSync('rsa', {
  418. modulusLength: 2048,
  419. publicKeyEncoding: {
  420. type: 'pkcs1',
  421. format: 'pem'
  422. },
  423. privateKeyEncoding: {
  424. type: 'pkcs1',
  425. format: 'pem',
  426. cipher: 'aes-256-cbc',
  427. passphrase: secret
  428. }
  429. })
  430. await knex('settings').insert([
  431. {
  432. key: 'auth',
  433. value: {
  434. audience: 'urn:wiki.js',
  435. tokenExpiration: '30m',
  436. tokenRenewal: '14d',
  437. certs: {
  438. jwk: pem2jwk(certs.publicKey),
  439. public: certs.publicKey,
  440. private: certs.privateKey
  441. },
  442. secret,
  443. rootAdminUserId: userAdminId,
  444. guestUserId: userGuestId
  445. }
  446. },
  447. {
  448. key: 'flags',
  449. value: {
  450. experimental: false,
  451. authDebug: false,
  452. sqlLog: false
  453. }
  454. },
  455. {
  456. key: 'icons',
  457. value: {
  458. fa: {
  459. isActive: true,
  460. config: {
  461. version: 6,
  462. license: 'free',
  463. token: ''
  464. }
  465. },
  466. la: {
  467. isActive: true
  468. }
  469. }
  470. },
  471. {
  472. key: 'mail',
  473. value: {
  474. senderName: '',
  475. senderEmail: '',
  476. host: '',
  477. port: 465,
  478. name: '',
  479. secure: true,
  480. verifySSL: true,
  481. user: '',
  482. pass: '',
  483. useDKIM: false,
  484. dkimDomainName: '',
  485. dkimKeySelector: '',
  486. dkimPrivateKey: ''
  487. }
  488. },
  489. {
  490. key: 'search',
  491. value: {
  492. termHighlighting: true,
  493. dictOverrides: {}
  494. }
  495. },
  496. {
  497. key: 'security',
  498. value: {
  499. corsConfig: '',
  500. corsMode: 'OFF',
  501. cspDirectives: '',
  502. disallowFloc: true,
  503. disallowIframe: true,
  504. disallowOpenRedirect: true,
  505. enforceCsp: false,
  506. enforceHsts: false,
  507. enforceSameOriginReferrerPolicy: true,
  508. forceAssetDownload: true,
  509. hstsDuration: 0,
  510. trustProxy: false,
  511. authJwtAudience: 'urn:wiki.js',
  512. authJwtExpiration: '30m',
  513. authJwtRenewablePeriod: '14d',
  514. uploadMaxFileSize: 10485760,
  515. uploadMaxFiles: 20,
  516. uploadScanSVG: true
  517. }
  518. },
  519. {
  520. key: 'update',
  521. value: {
  522. lastCheckedAt: null,
  523. version: WIKI.version,
  524. versionDate: WIKI.releaseDate
  525. }
  526. },
  527. {
  528. key: 'userDefaults',
  529. value: {
  530. timezone: 'America/New_York',
  531. dateFormat: 'YYYY-MM-DD',
  532. timeFormat: '12h'
  533. }
  534. }
  535. ])
  536. // -> DEFAULT SITE
  537. await knex('sites').insert({
  538. id: siteId,
  539. hostname: '*',
  540. isEnabled: true,
  541. config: {
  542. title: 'My Wiki Site',
  543. description: '',
  544. company: '',
  545. contentLicense: '',
  546. footerExtra: '',
  547. pageExtensions: ['md', 'html', 'txt'],
  548. pageCasing: true,
  549. discoverable: false,
  550. defaults: {
  551. tocDepth: {
  552. min: 1,
  553. max: 2
  554. }
  555. },
  556. features: {
  557. ratings: false,
  558. ratingsMode: 'off',
  559. comments: false,
  560. contributions: false,
  561. profile: true,
  562. reasonForChange: 'required',
  563. search: true
  564. },
  565. logoText: true,
  566. sitemap: true,
  567. robots: {
  568. index: true,
  569. follow: true
  570. },
  571. authStrategies: [{ id: authModuleId, order: 0, isVisible: true }],
  572. locales: {
  573. primary: 'en',
  574. active: ['en']
  575. },
  576. assets: {
  577. logo: false,
  578. logoExt: 'svg',
  579. favicon: false,
  580. faviconExt: 'svg',
  581. loginBg: false
  582. },
  583. editors: {
  584. asciidoc: {
  585. isActive: true,
  586. config: {}
  587. },
  588. markdown: {
  589. isActive: true,
  590. config: {
  591. allowHTML: true,
  592. kroki: false,
  593. krokiServerUrl: 'https://kroki.io',
  594. latexEngine: 'katex',
  595. lineBreaks: true,
  596. linkify: true,
  597. multimdTable: true,
  598. plantuml: false,
  599. plantumlServerUrl: 'https://www.plantuml.com/plantuml/',
  600. quotes: 'english',
  601. tabWidth: 2,
  602. typographer: false,
  603. underline: true
  604. }
  605. },
  606. wysiwyg: {
  607. isActive: true,
  608. config: {}
  609. }
  610. },
  611. theme: {
  612. dark: false,
  613. codeBlocksTheme: 'github-dark',
  614. colorPrimary: '#1976D2',
  615. colorSecondary: '#02C39A',
  616. colorAccent: '#FF9800',
  617. colorHeader: '#000000',
  618. colorSidebar: '#1976D2',
  619. injectCSS: '',
  620. injectHead: '',
  621. injectBody: '',
  622. contentWidth: 'full',
  623. sidebarPosition: 'left',
  624. tocPosition: 'right',
  625. showSharingMenu: true,
  626. showPrintBtn: true,
  627. baseFont: 'roboto',
  628. contentFont: 'roboto'
  629. },
  630. uploads: {
  631. conflictBehavior: 'overwrite',
  632. normalizeFilename: true
  633. }
  634. }
  635. })
  636. // -> DEFAULT GROUPS
  637. await knex('groups').insert([
  638. {
  639. id: groupAdminId,
  640. name: 'Administrators',
  641. permissions: JSON.stringify(['manage:system']),
  642. rules: JSON.stringify([]),
  643. isSystem: true
  644. },
  645. {
  646. id: groupGuestId,
  647. name: 'Guests',
  648. permissions: JSON.stringify(['read:pages', 'read:assets', 'read:comments']),
  649. rules: JSON.stringify([
  650. {
  651. id: uuid(),
  652. name: 'Default Rule',
  653. roles: ['read:pages', 'read:assets', 'read:comments'],
  654. match: 'START',
  655. mode: 'DENY',
  656. path: '',
  657. locales: [],
  658. sites: []
  659. }
  660. ]),
  661. isSystem: true
  662. }
  663. ])
  664. // -> AUTHENTICATION MODULE
  665. await knex('authentication').insert({
  666. id: authModuleId,
  667. module: 'local',
  668. isEnabled: true,
  669. displayName: 'Local Authentication'
  670. })
  671. // -> USERS
  672. await knex('users').insert([
  673. {
  674. id: userAdminId,
  675. email: process.env.ADMIN_EMAIL ?? 'admin@example.com',
  676. auth: {
  677. [authModuleId]: {
  678. password: await bcrypt.hash(process.env.ADMIN_PASS || '12345678', 12),
  679. mustChangePwd: false, // TODO: Revert to true (below) once change password flow is implemented
  680. // mustChangePwd: !process.env.ADMIN_PASS,
  681. restrictLogin: false,
  682. tfaRequired: false,
  683. tfaSecret: ''
  684. }
  685. },
  686. name: 'Administrator',
  687. isSystem: false,
  688. isActive: true,
  689. isVerified: true,
  690. meta: {
  691. location: '',
  692. jobTitle: '',
  693. pronouns: ''
  694. },
  695. prefs: {
  696. timezone: 'America/New_York',
  697. dateFormat: 'YYYY-MM-DD',
  698. timeFormat: '12h',
  699. appearance: 'site',
  700. cvd: 'none'
  701. }
  702. },
  703. {
  704. id: userGuestId,
  705. email: 'guest@example.com',
  706. auth: {},
  707. name: 'Guest',
  708. isSystem: true,
  709. isActive: true,
  710. isVerified: true,
  711. meta: {},
  712. prefs: {
  713. timezone: 'America/New_York',
  714. dateFormat: 'YYYY-MM-DD',
  715. timeFormat: '12h',
  716. appearance: 'site',
  717. cvd: 'none'
  718. }
  719. }
  720. ])
  721. await knex('userGroups').insert([
  722. {
  723. userId: userAdminId,
  724. groupId: groupAdminId
  725. },
  726. {
  727. userId: userGuestId,
  728. groupId: groupGuestId
  729. }
  730. ])
  731. // -> STORAGE MODULE
  732. await knex('storage').insert({
  733. module: 'db',
  734. siteId,
  735. isEnabled: true,
  736. contentTypes: {
  737. activeTypes: ['pages', 'images', 'documents', 'others', 'large'],
  738. largeThreshold: '5MB'
  739. },
  740. assetDelivery: {
  741. streaming: true,
  742. directAccess: false
  743. },
  744. versioning: {
  745. enabled: false
  746. },
  747. state: {
  748. current: 'ok'
  749. }
  750. })
  751. // -> SCHEDULED JOBS
  752. await knex('jobSchedule').insert([
  753. {
  754. task: 'checkVersion',
  755. cron: '0 0 * * *',
  756. type: 'system'
  757. },
  758. {
  759. task: 'cleanJobHistory',
  760. cron: '5 0 * * *',
  761. type: 'system'
  762. },
  763. {
  764. task: 'refreshAutocomplete',
  765. cron: '0 */6 * * *',
  766. type: 'system'
  767. },
  768. {
  769. task: 'updateLocales',
  770. cron: '0 0 * * *',
  771. type: 'system'
  772. }
  773. ])
  774. await knex('jobLock').insert({
  775. key: 'cron',
  776. lastCheckedBy: 'init',
  777. lastCheckedAt: DateTime.utc().minus({ hours: 1 }).toISO()
  778. })
  779. WIKI.logger.info('Completed 3.0.0 database migration.')
  780. }
  781. export function down (knex) { }