aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar vnugent <public@vaughnnugent.com>2024-05-23 19:09:28 -0400
committerLibravatar vnugent <public@vaughnnugent.com>2024-05-23 19:09:28 -0400
commitb6d292014700d05a93aa4e486baedf37656f464a (patch)
treebb54c8122f30b715967e98d80c7acfb147183e1e
parent5b6b4c06bc4b974e1839ca47c91dd6c903f119fd (diff)
docs: Update readme instructions
-rw-r--r--README.md11
-rw-r--r--ci/config/config.json2
-rw-r--r--ci/container/docker-compose.yaml6
3 files changed, 12 insertions, 7 deletions
diff --git a/README.md b/README.md
index daf6eae..998109e 100644
--- a/README.md
+++ b/README.md
@@ -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.
diff --git a/ci/config/config.json b/ci/config/config.json
index 0d8b839..f776732 100644
--- a/ci/config/config.json
+++ b/ci/config/config.json
@@ -141,7 +141,7 @@
"interval": "infinite"
},
- "disabled app_log": {
+ "app_log": {
"path": "data/logs/applog.txt",
//"template": "serilog template for writing to file",
"flush_sec": 5,
diff --git a/ci/container/docker-compose.yaml b/ci/container/docker-compose.yaml
index 2840160..fa6b0aa 100644
--- a/ci/container/docker-compose.yaml
+++ b/ci/container/docker-compose.yaml
@@ -19,7 +19,7 @@ services:
environment:
MAX_BOOKMARKS: "5000"
REG_TOKEN_DURATION_MIN: "360" #6 hours
-
+
#SQL Config
SQL_LIB_PATH: "VNLib.Plugins.Extensions.Sql.SQLite.dll"
SQL_CONNECTION_STRING: "Data Source=data/simple-bookmark.db;"
@@ -35,7 +35,7 @@ services:
REDIS_CONNECTION_STRING: ""
#at least one node required if MEMCACHE_ONLY is false
VNCACHE_INITIAL_NODES: "[]"
-
+
#Accounts plugin config
MAX_LOGIN_ATTEMPS: "10"
@@ -58,6 +58,6 @@ services:
#Very Verbose plugin logging, required --debug CLI flag, prints literally everything to the logger
DEBUG_PLUGINS: "false"
-
+
SERVER_ARGS: "--setup" #remove the setup flag after you are done setting up the server