Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dustinlacewell/logseq-guide
A guide to deploy logseq.com
https://github.com/dustinlacewell/logseq-guide
Last synced: 4 months ago
JSON representation
A guide to deploy logseq.com
- Host: GitHub
- URL: https://github.com/dustinlacewell/logseq-guide
- Owner: dustinlacewell
- Created: 2021-01-21T06:54:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-05-20T05:58:33.000Z (about 3 years ago)
- Last Synced: 2024-01-16T03:27:34.248Z (5 months ago)
- Size: 17.6 KB
- Stars: 121
- Watchers: 6
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Lists
- awesome-stars - dustinlacewell/logseq-guide - A guide to deploy logseq.com (Others)
- awesome-logseq - logseq-guide - Self hosting Logseq (💡 Workflows and Innovations)
README
Reference: https://github.com/logseq/logseq/tree/defclass/electron#set-up-development-environment
## Prerequisites
1. Make sure all requirements listed at https://github.com/logseq/logseq/tree/defclass/electron#1-requirements are met
2. Install PostgreSQL create a DB called "logseq" and a user with SUPERUSER permissions
4. Install nginx & Certbot on your sever
5. Create GitHub application as discribed in https://docs.github.com/en/free-pro-team@latest/developers/apps/creating-a-github-app
in the App set the Homepage URL to https://yourdomain.com - call back URL to https://yourdomain.com/auth/github
Create a "client secret" & a "Private Key" for your app
in app permissions set "Contents" access to "read and Write"
Copy from your app
* App ID
* Client ID
* Client Secret
upload the pem file that was automatically downloaded when you created your app "Private Key" to your sever
## Running LogSeq
1. Clone the logseq repo git clone `https://github.com/logseq/logseq`
2. Download backend.jar from https://github.com/logseq/logseq/releases/tag/0.0.1-100 and place it in `~/logsec/resources`
3. In [~/logseq/src/main/frontend/config.cljs](https://github.com/logseq/logseq/blob/master/src/main/frontend/config.cljs)
line 18 replace
```clojure
(def website
(if dev?
"http://localhost:3000"
(util/format "https://%s.com" app-name)))
```
by
```clojure
(def website
(if dev?
"http://localhost:3000"
"https://yourdomain.com"))
```
line 38 replace
```clojure
(def github-app-name (if dev? GITHUB_APP_NAME "logseq"))
```
by
```clojure
(def github-app-name (if dev? GITHUB_APP_NAME "yourappname"))
```
4. Set the envrionment variables
```shell
export GITHUB_REDIRECT_URI="https://yourdomain.com/auth/github"
export ENVIRONMENT="production"
export JWT_SECRET="somepass"
export COOKIE_SECRET="54676c2c5324279480a6ee1af0792588"
export GITHUB_APP2_NAME="yourappname"
export GITHUB_APP2_ID="appID"
export GITHUB_APP2_KEY="AppClientID"
export GITHUB_APP2_SECRET="AppClientSecret"
export GITHUB_APP_PEM="/path/to/github/pem/file/yourappname.2021-01-19.private-key.pem"
export LOG_PATH="/tmp/logseq"
export DATABASE_URL="postgres://localhost:5432/logseq"
export PG_USERNAME="username"
export PG_PASSWORD="password"
export WEBSITE_URL="https://yourdomain.com/"
export COOKIE_DOMAIN="yourdomain.com"
```
5. switch to `~/logsec` and run `yarn` then, compile using `yarn release`
6. run from `~/logsec` using `java -Duser.timezone=UTC -jar ./static/logseq.jar`
## Publishing LogSeq
Now we need to "server" your self hosted logseq to the internet to do that
1. Create 2 DNS records `domain.com` & `asset.domain.com` & get a certificate for each using [[Certbot]]
2. configure Nginx to
- rewrite 'asset.logseq.com' to 'asset.domain.com';
- rewrite 'logseq.com' to 'domain.com';
- reverse proxy requests to 'domain.com' to 'logseq.jar' (http://localhost:3000)
- serve 'asset.domain.com' to `/path/to/logseq/public/`
A dummy copy of the ngix.conf file can be found [here](./ngnix.conf)
## Hardcoded values
`shadow-cljs.edn`: line 16
```clojure
:release {:asset-path "https://asset.logseq.com/static/js"}
```
`src/main/frontend/config.cljs`: line 17
```clojure
(def app-name "logseq")
```
`src/main/frontend/config.cljs`: line 18-21
```clojure
(def website
(if dev?
"http://localhost:3000"
(util/format "https://%s.com" app-name)))
```
`src/main/frontend/config.cljs`: line 28
```clojure
(def asset-domain (util/format "https://asset.%s.com"
app-name))
```
`logseq.jar/static/js/publishing/cljs-runtime`: line 34
```clojure
frontend.config.app_name = "logseq";
```
`logseq.jar/static/js/publishing/cljs-runtime`: line 34
```clojure
frontend.config.website = (cljs.core.truth_(frontend.config.dev_QMARK_)?"http://localhost:3000":frontend.util.format.cljs$core$IFn$_invoke$arity$variadic("https://%s.com",cljs.core.prim_seq.cljs$core$IFn$_invoke$arity$2([frontend.config.app_name], 0)));
```
`logseq.jar/static/js/publishing/cljs-runtime`: line 36
```clojure
frontend.config.asset_domain = frontend.util.format.cljs$core$IFn$_invoke$arity$variadic("https://asset.%s.com",cljs.core.prim_seq.cljs$core$IFn$_invoke$arity$2([frontend.config.app_name], 0));
```
`logseq.jar/static/js/cljs-runtime/frontend.config.js`: line 34
```clojure
frontend.config.app_name = "logseq";
```
`logseq.jar/static/js/cljs-runtime/frontend.config.js`: line 34
```clojure
frontend.config.website = (cljs.core.truth_(frontend.config.dev_QMARK_)?"http://localhost:3000":frontend.util.format.cljs$core$IFn$_invoke$arity$variadic("https://%s.com",cljs.core.prim_seq.cljs$core$IFn$_invoke$arity$2([frontend.config.app_name], 0)));
```
`logseq.jar/static/js/cljs-runtime/frontend.config.js`: line 36
```clojure
frontend.config.asset_domain = frontend.util.format.cljs$core$IFn$_invoke$arity$variadic("https://asset.%s.com",cljs.core.prim_seq.cljs$core$IFn$_invoke$arity$2([frontend.config.app_name], 0));
```