aboutsummaryrefslogtreecommitdiff
path: root/nixops/modules/websites/tools/ether/etherpad_lite.nix
blob: 14ad56507ca08cf6bb0e2e0c0b4173bf3e367b0a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
{ env, fetchedGithub, fetchurl, stdenv, writeText, pkgs, cacert }:
let
  listenPort = env.listenPort;
  sessionkey = writeText "SESSIONKEY.txt" env.session_key;
  apikey = writeText "APIKEY.txt" env.api_key;
  jquery = fetchurl {
    url = https://code.jquery.com/jquery-1.9.1.js;
    sha256 = "0h4dk67yc9d0kadqxb6b33585f3x3559p6qmp70l00qwq030vn3v";
  };
  etherpad_modules = [
    "ep_aa_file_menu_toolbar"
    "ep_adminpads"
    "ep_align"
    "ep_bookmark"
    "ep_clear_formatting"
    "ep_colors"
    "ep_copy_paste_select_all"
    "ep_cursortrace"
    "ep_embedmedia"
    "ep_font_family"
    "ep_font_size"
    "ep_headings2"
    "ep_ldapauth"
    "ep_line_height"
    "ep_markdown"
    "ep_previewimages"
    "ep_ruler"
    "ep_scrollto"
    "ep_set_title_on_pad"
    "ep_subscript_and_superscript"
    "ep_timesliderdiff"
    ];
  keys = [
    {
      dest = "webapps/tools-etherpad-apikey";
      permissions = "0400";
      text = env.api_key;
    }
    {
      dest = "webapps/tools-etherpad-sessionkey";
      permissions = "0400";
      text = env.session_key;
    }
    {
      dest = "webapps/tools-etherpad";
      permissions = "0400";
      text =
        # Make sure we’re not rebuilding whole libreoffice just because of a
        # dependency
        let libreoffice = (import <nixpkgs> {}).libreoffice-fresh;
        in
        ''
          {
            "title": "Etherpad",
            "favicon": "favicon.ico",

            "ip": "127.0.0.1",
            "port" : ${env.listenPort},
            "showSettingsInAdminPage" : false,
            "dbType" : "postgres",
            "dbSettings" : {
              "user"    : "${env.postgresql.user}",
              "host"    : "${env.postgresql.socket}",
              "password": "${env.postgresql.password}",
              "database": "${env.postgresql.database}",
              "charset" : "utf8mb4"
            },

            "defaultPadText" : "Welcome to Etherpad!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at http:\/\/etherpad.org\n",
            "padOptions": {
              "noColors": false,
              "showControls": true,
              "showChat": true,
              "showLineNumbers": true,
              "useMonospaceFont": false,
              "userName": false,
              "userColor": false,
              "rtl": false,
              "alwaysShowChat": false,
              "chatAndUsers": false,
              "lang": "en-gb"
            },

            "suppressErrorsInPadText" : false,
            "requireSession" : false,
            "editOnly" : false,
            "sessionNoPassword" : false,
            "minify" : true,
            "maxAge" : 21600,
            "abiword" : null,
            "soffice" : "${libreoffice}/bin/soffice",
            "tidyHtml" : "${pkgs.html-tidy}/bin/tidy",
            "allowUnknownFileEnds" : true,
            "requireAuthentication" : false,
            "requireAuthorization" : false,
            "trustProxy" : false,
            "disableIPlogging" : false,
            "automaticReconnectionTimeout" : 0,
            "scrollWhenFocusLineIsOutOfViewport": {
              "percentage": {
                "editionAboveViewport": 0,
                "editionBelowViewport": 0
              },
              "duration": 0,
              "scrollWhenCaretIsInTheLastLineOfViewport": false,
              "percentageToScrollWhenUserPressesArrowUp": 0
            },
            "users": {
              "ldapauth": {
                "url": "ldaps://${env.ldap.host}",
                "accountBase": "${env.ldap.base}",
                "accountPattern": "(&(memberOf=cn=users,cn=etherpad,ou=services,dc=immae,dc=eu)(uid={{username}}))",
                "displayNameAttribute": "cn",
                "searchDN": "cn=etherpad,ou=services,dc=immae,dc=eu",
                "searchPWD": "${env.ldap.password}",
                "groupSearchBase": "${env.ldap.base}",
                "groupAttribute": "member",
                "groupAttributeIsDN": true,
                "searchScope": "sub",
                "groupSearch": "(memberOf=cn=groups,cn=etherpad,ou=services,dc=immae,dc=eu)",
                "anonymousReadonly": false
              }
            },
            "socketTransportProtocols" : ["xhr-polling", "jsonp-polling", "htmlfile"],
            "loadTest": false,
            "indentationOnNewLine": false,
            "toolbar": {
              "left": [
                ["bold", "italic", "underline", "strikethrough"],
                ["orderedlist", "unorderedlist", "indent", "outdent"],
                ["undo", "redo"],
                ["clearauthorship"]
              ],
              "right": [
                ["importexport", "timeslider", "savedrevision"],
                ["settings", "embed"],
                ["showusers"]
              ],
              "timeslider": [
                ["timeslider_export", "timeslider_returnToPad"]
              ]
            },
            "loglevel": "INFO",
            "logconfig" : { "appenders": [ { "type": "console" } ] }
          }
        '';
    }
  ];
  webappDir = stdenv.mkDerivation (fetchedGithub ./etherpad-lite.json // rec {
    __noChroot = true;
    patches = [ ./libreoffice_patch.diff ];
    buildPhase = ''
      export GIT_SSL_CAINFO=${cacert}/etc/ssl/certs/ca-bundle.crt
      export SSL_CERT_FILE=${cacert}/etc/ssl/certs/ca-bundle.crt
      export HOME=$PWD

      touch src/.ep_initialized
      cp -v src/static/custom/js.template src/static/custom/index.js
      cp -v src/static/custom/js.template src/static/custom/pad.js
      cp -v src/static/custom/js.template src/static/custom/timeslider.js
      cp -v src/static/custom/css.template src/static/custom/index.css
      cp -v src/static/custom/css.template src/static/custom/pad.css
      cp -v src/static/custom/css.template src/static/custom/timeslider.css

      sed -i 's/var\/dirty.db/\/var\/lib\/etherpad-lite\/dirty.db/g' \
        settings.json.template

      mkdir -v node_modules
      ln -s ../src node_modules/ep_etherpad-lite

      node bin/doc/generate doc/index.md --format=html \
        --template=doc/template.html > documentation.html

      cd src
      npm install
      cd ..
      ${builtins.concatStringsSep "\n"
        (map (n: "npm install ${n}; touch node_modules/${n}/.ep_initialized") etherpad_modules)}
      '';
    installPhase = ''
      mkdir -p $out
      install -t $out/src/ -vDm 644 src/.ep_initialized
      cp -a node_modules $out/
      cp -a src/* $out/src/
      ln -sf /var/secrets/webapps/tools-etherpad-sessionkey $out/SESSIONKEY.txt
      ln -sf /var/secrets/webapps/tools-etherpad-apikey $out/APIKEY.txt
      cp ${jquery} $out/src/static/js/jquery.js

      mkdir $out/doc
      install -t "$out/doc/" \
        -vDm 644 {CHANGELOG,CONTRIBUTING,README}.md \
        -vDm 644 documentation.html
    '';
    buildInputs = [ pkgs.nodejs pkgs.python ];
  });
in
  {
    inherit webappDir keys listenPort;
  }