summaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/Readme.md b/Readme.md
index 53b190f..9d146e0 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,20 +1,19 @@
# OKCMS
> "Pretty good"
+>
> - Steve Jobs
-
## To run the demo:
-* npm install
-* cd examples
-* node index
+- npm install
+- cd examples
+- node index
Server will be running on http://lvh.me:1337/
Admin area available on http://lvh.me:1337/admin/
-
## Config
To access the admin area, you need to set a username and password.
@@ -27,6 +26,7 @@ OK_PASS=password
```
S3 needs to be configured in the same way:
+
```
S3_KEY=s3key
S3_SECRET=s3secret
@@ -73,3 +73,13 @@ Valid datatypes include:
- double-captioned-image-list
- meta
+## Local S3
+
+If you don't want to use S3 and you have enough disk space locally, you can just write them locally. Supply these options to the S3 service configuration (pathss with trailing slash!).
+
+```
+local: {
+ localPath: "/home/username/my-cool-website-pro/public/local-files/",
+ remotePath: "/local-files/",
+},
+```