boxlet 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +82 -9
- data/lib/boxlet/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a6d7e5f493bed4061382d3948eeefd5e8c05c69a
|
|
4
|
+
data.tar.gz: 1110db140ef82acce692bf102e0813dde7213060
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7a1086d5b524547e517f5b99454c3d9a035754c3c2bd131860f466675ecb8bfda12190f415361ecd0c39e90c111ceb15dc15b71ba957eb5ed52f473e907a4dd8
|
|
7
|
+
data.tar.gz: 4116a07c56b25aab3848b5deddbe6d1ece5af309053ea84ea4cb034d2a99b610db822bfc294b17ad839aed353010ac3354d80195500517192f02dfb176b27850
|
data/README.md
CHANGED
|
@@ -1,24 +1,97 @@
|
|
|
1
1
|
# Boxlet
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Boxlet is a server + mobile app system that allows you to take advantage of free space on any cloud server you may have ssh access to.
|
|
4
|
+
|
|
5
|
+
From the mobile iOS app, you can specify any server:port where the Boxlet server is running to sync and backup your photos to a remote server.
|
|
4
6
|
|
|
5
|
-
## Installation
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
## Dependencies
|
|
8
9
|
|
|
9
|
-
|
|
10
|
+
- Ruby 2.0+ (Has been tested in 2.0 and 2.1.1)
|
|
11
|
+
- MongoDB 2.4+
|
|
12
|
+
- Linux server with free drive space and an open port
|
|
13
|
+
- iOS 7.1 (iPhone app)
|
|
10
14
|
|
|
11
|
-
And then execute:
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
## Installation
|
|
14
17
|
|
|
15
|
-
|
|
18
|
+
`gem install boxlet`
|
|
16
19
|
|
|
17
|
-
$ gem install boxlet
|
|
18
20
|
|
|
19
21
|
## Usage
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
Run `boxlet` from any folder to stat the server with default settings.
|
|
24
|
+
|
|
25
|
+
See below for config and parameters.
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## Config
|
|
29
|
+
|
|
30
|
+
Here's a sample Boxlet configuration file `config.yml` with default values populated:
|
|
31
|
+
|
|
32
|
+
```yml
|
|
33
|
+
# config.yml
|
|
34
|
+
|
|
35
|
+
# Environment
|
|
36
|
+
environment: development
|
|
37
|
+
debug: true
|
|
38
|
+
|
|
39
|
+
# File system parameters
|
|
40
|
+
path: ./
|
|
41
|
+
upload_dir: ./uploads
|
|
42
|
+
tmp_dir: /tmp
|
|
43
|
+
file_system_root: /
|
|
44
|
+
|
|
45
|
+
# Capacity is either a percentage of available space on the drive or number in MB
|
|
46
|
+
capacity: 90%
|
|
47
|
+
|
|
48
|
+
# Server type and listen parameters
|
|
49
|
+
port: 8077
|
|
50
|
+
host: localhost
|
|
51
|
+
server_type: thin
|
|
52
|
+
daemonize: false
|
|
53
|
+
|
|
54
|
+
# Database config
|
|
55
|
+
db:
|
|
56
|
+
development:
|
|
57
|
+
host: localhost
|
|
58
|
+
db: boxlet_dev
|
|
59
|
+
production:
|
|
60
|
+
host: localhost
|
|
61
|
+
# port:
|
|
62
|
+
# user:
|
|
63
|
+
# pass:
|
|
64
|
+
db: boxlet
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
All config options are available as command-line parameters
|
|
69
|
+
|
|
70
|
+
- Path: `-f` or `--path`
|
|
71
|
+
- Default: `./`
|
|
72
|
+
- Port: `-p` or `--port`
|
|
73
|
+
- Default: `8077`
|
|
74
|
+
- Host: `-o` or `--host`
|
|
75
|
+
- Default: `localhost`
|
|
76
|
+
- Public: `0.0.0.0`
|
|
77
|
+
- Server Type: `-s` or `--server_type`
|
|
78
|
+
- Default: `rack`
|
|
79
|
+
- Environment: `-E` or `--environment`
|
|
80
|
+
- Default: `development`
|
|
81
|
+
- Daemonize: `-D` or `--daemonize`
|
|
82
|
+
- Default: `false`
|
|
83
|
+
- Debug: `-d` or `--debug`
|
|
84
|
+
- Default: `true`
|
|
85
|
+
- Upload Directory: `-U` or `--upload_dir`
|
|
86
|
+
- Default: `./uploads`
|
|
87
|
+
- Temp Directory: `-T` or `--tmp_dir`
|
|
88
|
+
- Default: `./tmp`
|
|
89
|
+
- File System Root: `-r` or `--file_system_root`
|
|
90
|
+
- Default: `/`
|
|
91
|
+
- Capacity: `-C` or `--capacity`
|
|
92
|
+
- Default: `90%`
|
|
93
|
+
|
|
94
|
+
|
|
22
95
|
|
|
23
96
|
## Contributing
|
|
24
97
|
|
data/lib/boxlet/version.rb
CHANGED