Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Working #12

Merged
merged 42 commits into from
May 19, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
c1f5b90
Added info on #1
Apr 26, 2022
6bd4ecc
Issue #5 work
Apr 28, 2022
ac840ab
Merged in master
Apr 28, 2022
e605bd4
Turns out I own the domain
Apr 30, 2022
7625031
Resolves #8
May 4, 2022
236d9a0
Merge branch 'master' into working
May 4, 2022
26be895
Fixes #10. Added tests. Bumped up the versions of everything for some…
May 17, 2022
eb4dff9
Missing eslint?
May 17, 2022
e1c71c3
Bump version. Add more actions
May 17, 2022
9824624
Build only on pr. Build just the latest
May 17, 2022
07b1045
Wait for the input before firing a new location
May 17, 2022
05c037b
More tests
May 17, 2022
1754934
Release code testing
May 19, 2022
bc27d84
Release code testing
May 19, 2022
93ee7ea
Release code testing
May 19, 2022
edc70d9
Release code testing
May 19, 2022
e838fc9
Release code testing to much indent?
May 19, 2022
be269ff
Release relative path
May 19, 2022
9253ed5
Release relative path
May 19, 2022
24de379
Im an expert at these sorts of things
May 19, 2022
992ef91
just not a very good expert
May 19, 2022
fb5f70e
or I am just a really good random number generator
May 19, 2022
2acd6f5
Why is it failing just in github
May 19, 2022
7e587be
To annoying to pass in the whole working directory between jobs
May 19, 2022
b9c2e2d
Fix the test
May 19, 2022
5ca5bd5
Fix the test
May 19, 2022
fb43a0d
Getting closer
FoxUSA May 19, 2022
14670ce
I tire of the search tests random failures only on actions
FoxUSA May 19, 2022
d57351a
Back to two files
FoxUSA May 19, 2022
761f9bb
Back to two files
FoxUSA May 19, 2022
c1000c7
Back to two files
FoxUSA May 19, 2022
88be298
Correct variable syntax
FoxUSA May 19, 2022
9503919
release files artifact
FoxUSA May 19, 2022
c193f3e
helps if you save
FoxUSA May 19, 2022
849c3c7
Testing things
FoxUSA May 19, 2022
701cbd5
Testing things
FoxUSA May 19, 2022
807dd30
Testing things
FoxUSA May 19, 2022
667e432
Testing things
FoxUSA May 19, 2022
fbe0f9c
Testing things
FoxUSA May 19, 2022
180d21f
Testing things
FoxUSA May 19, 2022
5160e37
Auto create release
FoxUSA May 19, 2022
2fbf657
Hopefully this works
FoxUSA May 19, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Added info on #1
  • Loading branch information
Jake committed Apr 26, 2022
commit c1f5b90e1eb2de0ef30c6d4155026ab1984ff278
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
FROM nginx
ADD dist/ /usr/share/nginx/html/
12 changes: 12 additions & 0 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,15 @@ npm run test:unit

### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).

### Build the Docker container
```
docker build -t foxusa/storedown:$tag .
# On M1 Macs
docker build --platform linux/amd64 -t foxusa/storedown:latest -t foxusa/storedown:$version .
```

### Push container
```
docker push --all-tags foxusa/storedown
```
89 changes: 87 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,91 @@
# How to Install StoreDown

We are still early days.
We are still in the early days.
I hope to reduce the skills required to use StoreDown.

Currently you can download a [zip of the most recent release](https://github.com/FoxUSA/StoreDown/releases) and extract it in your webserver of choice(S3, Apache, NGINX, etc ....)
> Remember you need to Deploy StoredDown and configure an Apache CouchDB instance.
> StoreDown uses a CouchDB database to sync.
> Instructions on how to setup CouchDB are at the bottom of this file.
> TLDR: Pick an option __AND__ configure CouchDB

## Option 1:
You can download a [zip of the most recent release](https://github.com/FoxUSA/StoreDown/releases) and extract it in your webserver of choice(S3, Apache, NGINX, etc ....)

## Option 2: Using `docker`
`docker run -d -p 8080:80 foxusa/storedown`

## Option 3: Using docker-compose
> If you want to use SSL/TLS skip this and go down to that section
>
Put the following text in a `docker-compose.yml`.
Make sure to set all the items marked `#TODO`.
Also make sure this file is in a secure place.
Your credentials are stored in it.
```
version: "2"
services:
storedown:
image: foxusa/storedown
restart: always
ports:
- "80:80"
couchdb:
image: couchdb
restart: always
volumes:
- "<HOST_LOCATION>:/opt/couchdb/data" #TODO set this to prevent accidentally deleting your database data
ports:
- "5984:5984"
environment:
COUCHDB_USER: user #TODO set this
COUCHDB_PASSWORD: password #TODO set this
```

You can then run `docker-compose up -d` to start the services.

### SSL/TLS
Create a folder with a SSL `private.key` and `public.crt` this gets mounted by nginx to encrypt connections.
The `public.crt` file should have your servers cert and the whole cert chain appended to it.

Create a nginx config file that proxies CouchDB traffic via SSL.
[Here is an example you can use as is.](https://github.com/FoxUSA/OpenNote-Docker/blob/master/samples/nginx/default.conf)

Mount these files using the following `docker-compose.yml`
```
version: "2"
services:
storedown:
image: foxusa/storedown
restart: always
volumes:
- $HOST_LOCATION/certs:/root/certs:ro #TODO set this
- $HOST_LOCATION/storedown.default.conf:/etc/nginx/conf.d/default.conf:ro #TODO file created above
ports:
- 80:80
- 443:443
- 6984:6984 #CouchDB Proxy
links:
- couchdb:couchdb

couchdb:
restart: always
image: couchdb
volumes:
- /opt/StoreDown/couchdb:/opt/couchdb/data
ports:
- 5984:5984
environment:
COUCHDB_USER: $user #TODO set this
COUCHDB_PASSWORD: $password #TODO set this

```

You can then run `docker-compose up -d` to start the services.

---

### CouchDB config
- [ ] Go to `http:https://$serverurl:5984/_utils/#_config/nonode@nohost/cors` and enable CORS for your domain.
- [ ] Go to `http:https://$serverurl:5984/_utils/#_config/nonode@nohost` and set `require_valid_user`(`chttpd` section) to `true`.
>If you are unable to get to the login screen after setting that, you can access it via `http:https://$serverurl:5984/_utils/#login`
- [ ] Then open StoreDown and log in with the username, password, url, port, and database you configured.