From e0801581be8fa061e44671bb8dd25260eb6b3a67 Mon Sep 17 00:00:00 2001
From: Jules <jules@asdf.us>
Date: Tue, 12 Dec 2017 22:13:51 -0500
Subject: add to readme and fix server for proxy situation

---
 README | 54 ++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 42 insertions(+), 12 deletions(-)

(limited to 'README')

diff --git a/README b/README
index 70d3611..2bf7071 100644
--- a/README
+++ b/README
@@ -1,27 +1,57 @@
-bucky
-=====
+# bucky
 
-# npm install
-# brew install mysql (used for main database)
-# brew install mongodb (used for sessions)
-# set up the mysql database:
+## Install
 
+### osx
+
+```
+npm install
+brew install mysql (used for main database)
+brew install mongodb (used for sessions)
+```
+
+### MySQL
+
+```
 mysql -uroot
 CREATE USER 'carbon'@'localhost' IDENTIFIED BY 'the_password';
 CREATE DATABASE bucky;
 USE bucky;
 GRANT ALL PRIVILEGES ON bucky.* TO 'carbon'@'localhost';
+```
+
+Copy .env-sample to .env and edit the values accordingly.
 
-# copy .env-sample to .env and edit the values to correspond
-# load up a copy of bucky
+#### Loading an old bucky db dump
 
-scp carbon@carbonpictures.com:bucky-20150903.sql .
+```
 mysql -u carbon -p bucky < bucky-20150903.sql
+```
+
+### MongoDB
+
+Mongo is only used for session management and will ideally be replaced.
+
+### Berkeley DB
 
-# run the migrations (makes most blob fields into text)
+Used for the search, `libdb` should already be installed on your system.
 
-knex migrate:latest
+## Building the search index
 
-# node index
+This script should be run regularly to keep the search index fresh:
+
+```
+npm run build:search
+```
+
+## Running
+
+You may have to include the .so files for bdb: `export LD_LIBRARY_PATH=/var/www/bucky.asdf.us/bucky3/node_modules/berkeleydb/lib`
+
+```
+npm start
+```
 
 Server will be running at http://lvh.me:5000/
+
+
-- 
cgit v1.2.3-70-g09d2