Extract config.js from common.js to make client setting file clean and also make upgrade easier

This commit is contained in:
Wu Cheng-Han 2016-10-10 16:25:51 +08:00
parent 917537ddbf
commit bf4c6d021c
9 changed files with 21 additions and 17 deletions

2
.gitignore vendored
View file

@ -19,5 +19,5 @@ backups/
# ignore config files # ignore config files
config.json config.json
public/js/common.js public/js/config.js
.sequelizerc .sequelizerc

View file

@ -83,10 +83,10 @@ There are some configs you need to change in the files below
``` ```
./config.json --- for server settings ./config.json --- for server settings
./public/js/common.js --- for client settings ./public/js/config.js --- for client settings
``` ```
Client settings `common.js` Client settings `config.js`
--- ---
| variables | example values | description | | variables | example values | description |
@ -148,7 +148,7 @@ Third-party integration api key settings
| ------- | --------- | ----------- | | ------- | --------- | ----------- |
| facebook, twitter, github, gitlab, dropbox, google | `config.json` | for signin | | facebook, twitter, github, gitlab, dropbox, google | `config.json` | for signin |
| imgur | `config.json` | for image upload | | imgur | `config.json` | for image upload |
| google drive, dropbox | `public/js/common.js` | for export and import | | google drive, dropbox | `public/js/config.js` | for export and import |
Third-party integration oauth callback urls Third-party integration oauth callback urls
--- ---

View file

@ -25,8 +25,8 @@ if [ ! -f config.json ]; then
cp config.json.example config.json cp config.json.example config.json
fi fi
if [ ! -f publis/js/common.js ]; then if [ ! -f publis/js/config.js ]; then
cp public/js/common.js.example public/js/common.js cp public/js/config.js.example public/js/config.js
fi fi
if [ ! -f .sequelizerc ]; then if [ ! -f .sequelizerc ]; then
@ -43,7 +43,7 @@ Edit the following config file to setup hackmd server and client.
Read more info at https://github.com/hackmdio/hackmd#configuration-files Read more info at https://github.com/hackmdio/hackmd#configuration-files
* config.json -- server config * config.json -- server config
* public/js/common.js -- client config * public/js/config.js -- client config
* .sequelizerc -- db config * .sequelizerc -- db config
EOF EOF

View file

@ -1,14 +1,4 @@
//common //common
var domain = ''; // domain name
var urlpath = ''; // sub url path, like: www.example.com/<urlpath>
//settings
var debug = false;
var GOOGLE_API_KEY = '';
var GOOGLE_CLIENT_ID = '';
var DROPBOX_APP_KEY = '';
var port = window.location.port; var port = window.location.port;
var serverurl = window.location.protocol + '//' + (domain ? domain : window.location.hostname) + (port ? ':' + port : '') + (urlpath ? '/' + urlpath : ''); var serverurl = window.location.protocol + '//' + (domain ? domain : window.location.hostname) + (port ? ':' + port : '') + (urlpath ? '/' + urlpath : '');
var noteid = urlpath ? window.location.pathname.slice(urlpath.length + 1, window.location.pathname.length).split('/')[1] : window.location.pathname.split('/')[1]; var noteid = urlpath ? window.location.pathname.slice(urlpath.length + 1, window.location.pathname.length).split('/')[1] : window.location.pathname.split('/')[1];

View file

@ -0,0 +1,10 @@
//config
var domain = ''; // domain name
var urlpath = ''; // sub url path, like: www.example.com/<urlpath>
//settings
var debug = false;
var GOOGLE_API_KEY = '';
var GOOGLE_CLIENT_ID = '';
var DROPBOX_APP_KEY = '';

View file

@ -75,6 +75,7 @@
<script src="<%- url %>/vendor/keymaster/keymaster.js" defer></script> <script src="<%- url %>/vendor/keymaster/keymaster.js" defer></script>
<script src="<%- url %>/js/google-drive-upload.js" defer></script> <script src="<%- url %>/js/google-drive-upload.js" defer></script>
<script src="<%- url %>/js/google-drive-picker.js" defer></script> <script src="<%- url %>/js/google-drive-picker.js" defer></script>
<script src="<%- url %>/js/config.js" defer></script>
<script src="<%- url %>/js/common.js" defer></script> <script src="<%- url %>/js/common.js" defer></script>
<script src="<%- url %>/js/extra.js" defer></script> <script src="<%- url %>/js/extra.js" defer></script>
<script src="<%- url %>/js/render.js" defer></script> <script src="<%- url %>/js/render.js" defer></script>

View file

@ -205,6 +205,7 @@
<script src="<%- url %>/vendor/file-saver/FileSaver.min.js" defer></script> <script src="<%- url %>/vendor/file-saver/FileSaver.min.js" defer></script>
<script src="<%- url %>/vendor/store-js/store.min.js" defer></script> <script src="<%- url %>/vendor/store-js/store.min.js" defer></script>
<script src="<%- url %>/vendor/lz-string/libs/lz-string.min.js" defer></script> <script src="<%- url %>/vendor/lz-string/libs/lz-string.min.js" defer></script>
<script src="<%- url %>/js/config.js" defer></script>
<script src="<%- url %>/js/common.js" defer></script> <script src="<%- url %>/js/common.js" defer></script>
<script src="<%- url %>/js/history.js" defer></script> <script src="<%- url %>/js/history.js" defer></script>
<script src="<%- url %>/js/cover.js" defer></script> <script src="<%- url %>/js/cover.js" defer></script>

View file

@ -127,6 +127,7 @@
<script src="<%- url %>/vendor/viz.js/viz.js" defer></script> <script src="<%- url %>/vendor/viz.js/viz.js" defer></script>
<script src="<%- url %>/vendor/pdfobject/pdfobject.min.js" defer></script> <script src="<%- url %>/vendor/pdfobject/pdfobject.min.js" defer></script>
<script src="<%- url %>/vendor/md-toc.js" defer></script> <script src="<%- url %>/vendor/md-toc.js" defer></script>
<script src="<%- url %>/js/config.js" defer></script>
<script src="<%- url %>/js/common.js" defer></script> <script src="<%- url %>/js/common.js" defer></script>
<script src="<%- url %>/js/extra.js" defer></script> <script src="<%- url %>/js/extra.js" defer></script>
<script src="<%- url %>/js/render.js" defer></script> <script src="<%- url %>/js/render.js" defer></script>

View file

@ -122,6 +122,7 @@
<script src="<%- url %>/vendor/viz.js/viz.js" defer></script> <script src="<%- url %>/vendor/viz.js/viz.js" defer></script>
<script src="<%- url %>/vendor/pdfobject/pdfobject.min.js" defer></script> <script src="<%- url %>/vendor/pdfobject/pdfobject.min.js" defer></script>
<script src="<%- url %>/vendor/md-toc.js" defer></script> <script src="<%- url %>/vendor/md-toc.js" defer></script>
<script src="<%- url %>/js/config.js" defer></script>
<script src="<%- url %>/js/common.js" defer></script> <script src="<%- url %>/js/common.js" defer></script>
<script src="<%- url %>/js/extra.js" defer></script> <script src="<%- url %>/js/extra.js" defer></script>
<script src="<%- url %>/js/render.js" defer></script> <script src="<%- url %>/js/render.js" defer></script>