1
1
# Padlock Cloud
2
2
3
- Padlock Cloud is a cloud storage and synchronization service for the
4
- [ Padlock app] ( https://github.com/maklesoft/padlock/ ) implemented in Go. It provides a (mostly) RESTful api
5
- for storing and retrieving user data. Padlock Cloud does NOT implement any kind of
6
- diffing algorithm, nor does it attempt to provide any kind of cryptographic functionality. Any encryption,
7
- decryption and data consolidation should happen on the client side. Padlock Cloud merely provides a
8
- cloud-based storage for encrypted user data.
3
+ Padlock Cloud is a cloud storage service for the
4
+ [ Padlock app] ( https://github.com/maklesoft/padlock/ ) implemented in Go. It
5
+ provides a (mostly) RESTful api for storing and retrieving user data. Padlock
6
+ Cloud does NOT implement any kind of diffing algorithm, nor does it attempt to
7
+ provide any kind of cryptographic functionality. Any encryption, decryption and
8
+ data consolidation should happen on the client side. Padlock Cloud merely
9
+ provides a cloud-based storage for encrypted user data.
9
10
10
11
## How to install/build
11
12
12
- First, you'll need to have [ Go] ( https://golang.org/ ) installed on your system. Then simply run
13
+ First, you'll need to have [ Go] ( https://golang.org/ ) installed on your system.
14
+ Then simply run
13
15
14
16
``` sh
15
17
go get github.com/maklesoft/padlock-cloud
16
18
```
17
19
18
- This will download the source code into your ` $GOPATH ` and automatically build and install the
19
- ` padlock-cloud ` binary into ` $GOPATH/bin ` . Assuming you have ` $GOPATH/bin ` added
20
- to your path, you should be the be able to simply run the ` padlock-cloud ` command from anywhere.
20
+ This will download the source code into your ` $GOPATH ` and automatically build
21
+ and install the ` padlock-cloud ` binary into ` $GOPATH/bin ` . Assuming you have
22
+ ` $GOPATH/bin ` added to your path, you should be the be able to simply run the
23
+ ` padlock-cloud ` command from anywhere.
21
24
22
25
## Usage
23
26
24
- The ` padlock-cloud ` command provides commands for starting Padlock Cloud server and managing
25
- accounts. It can be configured through various flags and environment variables.
27
+ The ` padlock-cloud ` command provides commands for starting Padlock Cloud server
28
+ and managing accounts. It can be configured through various flags and
29
+ environment variables.
26
30
27
- Note that ** global flags** have to be specified ** before** the command and ** command-specific** flags
28
- ** after** the command but before any positional arguments.
31
+ Note that ** global flags** have to be specified ** before** the command and
32
+ ** command-specific** flags ** after** the command but before any positional
33
+ arguments.
29
34
30
35
``` sh
31
36
padlock-cloud [global options] command [command options] [arguments...]
@@ -37,16 +42,18 @@ For a list of available commands and global options, run.
37
42
padlock-cloud --help
38
43
```
39
44
40
- For information about a specific command, including command-specific options, run
45
+ For information about a specific command, including command-specific options,
46
+ run
41
47
42
48
``` sh
43
49
padlock-cloud command --help
44
50
```
45
51
46
52
### Config file
47
53
48
- The ` --config ` flag offers the option of using a configuration file instead of command line flags. The
49
- provided file should be in the [ YAML format] ( http://yaml.org/ ) . Here is an example configuration file:
54
+ The ` --config ` flag offers the option of using a configuration file instead of
55
+ command line flags. The provided file should be in the
56
+ [ YAML format] ( http://yaml.org/ ) . Here is an example configuration file:
50
57
51
58
``` yaml
52
59
---
69
76
70
77
` ` `
71
78
72
- **NOTE**: If you are using a config file, all other flags and environment variables will be ingored.
79
+ **NOTE**: If you are using a config file, all other flags and environment
80
+ variables will be ingored.
73
81
74
82
## Security Considerations
75
83
@@ -119,12 +127,13 @@ recommended to use this option in production environments at all times!
119
127
# ## Failed to load templates
120
128
121
129
` ` ` sh
122
- 2016/09/01 21:40:59 open asdf/templates /activate-auth-token-email.txt: no such file or directory
130
+ 2016/09/01 21:40:59 open some/path /activate-auth-token-email.txt: no such file or directory
123
131
` ` `
124
132
125
- The Padlock Cloud server requires various assets like templates for rendering emails, web
126
- pages etc. These are included in this repository under the `assets` folder. When you're running
127
- ` padlock-cloud` you'll have to make sure that it knows where to find these assets. You can do that
128
- via the `--assets-path` option. By default, the server will look for the templates under
129
- ` $GOPATH/src/github.com/maklesoft/padlock-cloud/assets/templates` which is where they will usually be
130
- if you installed `padlock-cloud` via `go get`.
133
+ The Padlock Cloud server requires various assets like templates for rendering
134
+ emails, web pages etc. These are included in this repository under the `assets`
135
+ folder. When you're running `padlock-cloud` you'll have to make sure that it
136
+ knows where to find these assets. You can do this via the `--assets-path`
137
+ option. By default, the server will look for the templates under
138
+ ` $GOPATH/src/github.com/maklesoft/padlock-cloud/assets/templates` which is
139
+ where they will usually be if you installed `padlock-cloud` via `go get`.
0 commit comments