diff options
author | vnugent <public@vaughnnugent.com> | 2024-06-04 15:59:02 -0400 |
---|---|---|
committer | vnugent <public@vaughnnugent.com> | 2024-06-04 15:59:02 -0400 |
commit | 71b581e006fda94aa675b7df9a7fbfe35d748b48 (patch) | |
tree | 3ae4832021a63249f53bd68b28759cd496397784 /README.md | |
parent | 28e67e58208a13bd5f9afb19b6a2e57f904eec80 (diff) |
Squashed commit of the following:v0.1.6
commit bbe3b9b80db68cf86e26bd2e40a07c1650031224
Author: vnugent <public@vaughnnugent.com>
Date: Tue Jun 4 15:54:42 2024 -0400
ignore npm version bump errors for build
commit 45816924e5a47710a6bc4ed0d59ea81a48eddd1e
Author: vnugent <public@vaughnnugent.com>
Date: Tue Jun 4 15:30:35 2024 -0400
project version in ui
commit 03357c9f7b7fa389d2d426e95d9854b7b04623f9
Author: vnugent <public@vaughnnugent.com>
Date: Tue Jun 4 12:59:30 2024 -0400
chore: Essentials upstream update
commit b6d292014700d05a93aa4e486baedf37656f464a
Author: vnugent <public@vaughnnugent.com>
Date: Thu May 23 19:09:28 2024 -0400
docs: Update readme instructions
commit 5b6b4c06bc4b974e1839ca47c91dd6c903f119fd
Author: vnugent <public@vaughnnugent.com>
Date: Thu May 23 18:17:56 2024 -0400
build(server): Update Docker config to support new vars
commit c7c9e8a441e99e1dc79e2a690d83281af463d817
Author: vnugent <public@vaughnnugent.com>
Date: Thu May 23 17:40:09 2024 -0400
update backend deps
commit 06eb12d107f2605cae0f14884de04058c02d29f7
Author: vnugent <public@vaughnnugent.com>
Date: Thu May 23 17:38:22 2024 -0400
chore: package updates and verify
commit c8e3ca86be45be05c1f76a7dd808275a1afaccb0
Author: vnugent <public@vaughnnugent.com>
Date: Thu May 16 17:10:27 2024 -0400
chore: Remove unused cache stuff
commit ba2ee1073a5042bda0afc2b56233fe99d491b39d
Merge: e6b4e60 28e67e5
Author: vnugent <public@vaughnnugent.com>
Date: Wed May 15 18:08:48 2024 -0400
Merge branch 'master' into develop
commit e6b4e605622f2b323fd3fe0aa01000f3986e3bba
Author: vnugent <public@vaughnnugent.com>
Date: Wed May 15 16:35:06 2024 -0400
build: Fix ssl container dir, and certificate automation
commit a710553aa5c0484b6934b8a5d4d16b1eb3ff2a88
Author: vnugent <public@vaughnnugent.com>
Date: Wed May 15 15:37:53 2024 -0400
ci: Admin form clear, polish build and release taskfiels
commit 372eb6a32a9891afb5035caa0805e8ed878416d8
Author: vnugent <public@vaughnnugent.com>
Date: Tue May 14 22:27:10 2024 -0400
default read secret pepper from file for bare-metal builds
commit 1b7270b40b65ef089bf40a14065227f742b8507e
Author: vnugent <public@vaughnnugent.com>
Date: Tue May 14 21:52:03 2024 -0400
chore: make container slightly easier to setup
commit 2deda50a167286bc93fd3871a1fd6dbf9f43c81f
Merge: 28f0f77 96ae7b0
Author: vnugent <public@vaughnnugent.com>
Date: Sun Apr 28 10:54:09 2024 -0400
Merge branch 'master' into develop
commit 28f0f774da975c04271445761b2de31aecf969ff
Author: vnugent <public@vaughnnugent.com>
Date: Sat Apr 27 23:11:48 2024 -0400
Add --no-cache arg to build image args
commit 22a1f5d374ec1a487944c6303066d0f15617cb12
Author: vnugent <public@vaughnnugent.com>
Date: Sat Apr 27 18:47:25 2024 -0400
fix: Upstream patch missing ! in middlware
commit f40ca2d4c26f81276d58760152592a918bf3cd87
Author: vnugent <public@vaughnnugent.com>
Date: Sat Apr 27 18:36:01 2024 -0400
chore: package updates
commit d7a3c957467e65ea7176170fba3c280ac18ac17e
Author: vnugent <public@vaughnnugent.com>
Date: Sun Apr 21 12:02:57 2024 -0400
chore: Package updates and minor QOL patches
commit 97a5bded5122708cf39d0e86bc24a5f31755bdd1
Merge: 56e0a38 5877c86
Author: vnugent <public@vaughnnugent.com>
Date: Tue Apr 9 17:38:02 2024 -0400
Merge branch 'master' into develop
commit 56e0a38b2ca246e8beeaef3c6c4b9c0ce7d0f09b
Author: vnugent <public@vaughnnugent.com>
Date: Tue Apr 9 17:35:13 2024 -0400
chore(app): Update deps, login spinner, curl msg, view prep
commit 0945210c0492dd8a8de99ccd8e5e66cf05e3a1c1
Merge: 24fac82 3c15d54
Author: vnugent <public@vaughnnugent.com>
Date: Tue Apr 2 14:58:59 2024 -0400
Merge branch 'master' into develop
commit 24fac82efe9e5c18e86ed535678640e7401472db
Author: vnugent <public@vaughnnugent.com>
Date: Tue Apr 2 14:54:20 2024 -0400
ci: Configure manual dep versions
commit d2ae31ec919d72e66d8b40db8394b55efd6ea6d3
Author: vnugent <public@vaughnnugent.com>
Date: Sun Mar 31 22:19:53 2024 -0400
ci: Native compression support for win
commit fa7fdef79c6d468022b77f81314ac129fe0cdc32
Merge: 308092d a01220a
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 13 21:26:55 2024 -0400
Merge branch 'master' into develop
commit 308092d6d743d0ba8f7ca86fd77e9c837dc46e88
Merge: 48637a8 9134093
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 13 21:01:02 2024 -0400
Merge branch 'master' into develop
commit 48637a8781fc951c307216f604fc1610e68691c3
Merge: 1e08c6d e326736
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 13 16:20:35 2024 -0400
Merge branch 'master' into develop
commit 1e08c6d2112459dc02a0ab873123c4a363b01d21
Author: vnugent <public@vaughnnugent.com>
Date: Wed Mar 13 16:17:58 2024 -0400
ci: verified container build ready for next release
commit 85a1e5b7cc5c99e97a2d4e99bbceb0d2139742ff
Author: vnugent <public@vaughnnugent.com>
Date: Tue Mar 12 22:05:16 2024 -0400
ci: exciting bare-metal build process, os support, smaller packages
commit 748cdbf4880d830fd794e92856e8c35a46e4f884
Author: vnugent <public@vaughnnugent.com>
Date: Mon Mar 11 21:21:18 2024 -0400
feat(app): #1 update libs & add curl support
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 11 |
1 files changed, 8 insertions, 3 deletions
@@ -43,7 +43,7 @@ I built Simple-Bookmark mostly because I didn't want the container lock-in. I al - Invite users with share links - Supports (and tested) SQLite, SQLServer, MySQL/MariaDB databases - It's quick <300ms load time & under 150kB with compression -- It's small, 142mb Docker image +- It's small, 127mb Docker image - Argon2Id password hashing with secure defaults - Supports enterprise services: HashiCorp Vault, SQLServer, Auth0, and Redis - Built-in TLS (TLS is required) @@ -64,8 +64,9 @@ docker build . -t vnuge/simple-bookmark docker-compose up -d ``` _Of course there is more setup involved, so take a look at the docs for more info_ + _This container does not need root permissions to run_ -The image should be about 139mb when built! I'm also hoping to get it down even smaller in the future. You may also use Podman in the same format, simply substitute the word `docker` with `podman` in the previous commands. +The image should be about 127mb when built! I'm also hoping to get it down even smaller in the future. You may also use Podman in the same format, simply substitute the word `docker` with `podman` in the previous commands. ### Bare-metal install >[!NOTE] @@ -86,6 +87,10 @@ Optionally create a self-signed TLS certificate using openssl and exports it to ``` shell sudo task create-cert #runs an openssl command ``` +Optionally generate a password pepper file +``` shell +task create-pepper #creates a pepper file in the secrets directory +``` Optionally set file permissions ```shell chmod -R 0750 . && chmod -R 0770 data/ #only data dir needs write permissions @@ -95,7 +100,7 @@ chmod -R 0750 . && chmod -R 0770 data/ #only data dir needs write permissions task setup #runs all setup rules ``` > [!IMPORTANT] -> This command attempts to move or compile native libraries on your system. Windows users will have to manually adjust their config file, or install VisualStudio build tools, otherwise you'll see a bunch of errors. +> By default this copies pre-compiled C libraries, you must be using Windows version 1904 or later. Quick start guide has more info, if you need to build the libraries yourself. #### First start Starting the server for the first time you'll want to enable setup mode to allow admin registration for the first time. This is operation insecure, please read the quick-start guide. |