-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
245 lines (204 loc) · 8.78 KB
/
Copy pathindex.html
File metadata and controls
245 lines (204 loc) · 8.78 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
<!DOCTYPE html>
<html>
<head>
<meta charset='utf-8'>
<meta http-equiv="X-UA-Compatible" content="chrome=1">
<meta name="description" content="FoldersJS : ">
<link rel="stylesheet" type="text/css" media="screen" href="stylesheets/stylesheet.css">
<style>
.inner { max-width: 1200px; }
</style>
<title>FoldersJS</title>
</head>
<body id="top">
<!-- HEADER -->
<div id="header_wrap" class="outer">
<header class="inner" style="padding-top: 2em; padding-bottom: 0;">
<a id="forkme_banner" href="https://github.com/foldersjs">Source</a>
<h1 id="project_title">
<img src="media/icon_transparent_64x64.png" height="64" width="64" alt="" style="vertical-align: middle; border: 0; box-shadow: none; -webkit-box-shadow: none;" />
<span>FoldersJS</span>
<span style="font-size: 0.33em;">by folders.io</span>
</h1>
<!--
<h2 id="project_tagline"></h2>
-->
</header>
</div>
<div id="footer_wrap" class="outer">
<footer class="inner">
<p>
<a href="#folders">Introduction</a>
<span aria-hidden="true">·</span>
<a href="#sdk">SDK</a>
<span aria-hidden="true">·</span>
<a href="#projects">Projects</a>
</p>
</footer>
</div>
<!-- MAIN CONTENT -->
<div id="main_content_wrap" class="outer">
<section style="max-width: 1200px; margin-left: auto; margin-right: auto;">
<h3>
<a id="folders" class="anchor" href="#folders" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Introduction</h3>
<div style="float: left; max-width: 600px;">
FoldersJS is a collection of projects presenting services as folders.
<hr />
<p>
<div style="text-align: center">
<img src="media/lib/matt-icons_folder-white-300px.png" width="300" alt="" style="vertical-align: middle">
<h3 style="display: inline-block; font-size: .9em">Folders are a metaphor for data access.</h3>
</div>
Folders have a name, a list of other items and a common set of properties.
</p>
</div>
<div style="float: right; max-width: 600px;">
When a folder is accessed a list of items and properties become viewable.
<hr />
<p id="trees">
<div style="text-align: center">
<h3 style="display: inline-block; font-size: .9em">A folder tree is an organizational concept.</h3>
<img src="media/lib/1269294461-300px.png" width="300" alt="" style="vertical-align: middle">
</div>
</p>
</div>
<div style="float: none; clear: both; max-width: 1200px; text-align: center;">
There are many computing activities that present folder-like qualities. FoldersJS provides a folders abstraction atop more complicated interfaces.
<p><a id="forkme_banner" style="position: relative;" href="https://github.com/foldersjs">Try it out</a></p>
</div>
</section>
<hr style = "float: none; clear: both"/>
<section id="main_content" class="inner">
<h3 id="sdk">SDK</h3>
<p>FoldersJS provides a software toolkit for client, server and peering relationships using a common set of features.</p>
<h2 id="basics">Basics</h2>
<p>
Folders are containers with a name and set of properties that can be opened to list further sub-folders and files.
The standards in web browsers are still evolving, relating to Files and File Systems.
In the alpha version of this software, all files present a file type and content type.
With the HTML5 standard, a file could be considered a Blob.
</p>
<h2 id="client">Client</h2>
<h3 id="client-cmd">Client commands</h3>
<ul>
<li>
<dfn id="ls"><abbr title="list">ls</abbr></dfn>
This command will list the contents of a folder.
</li>
<li>
<dfn id="cat"><abbr title="catenate">cat</abbr></dfn>
This command will read a file entry until it has been read completely or is canceled.
</li>
<li>
<dfn id="write">write</dfn>
This command will attempt to write data to a file entry.
</li>
</ul>
<h3 id="client-attr">Client attributes</h3>
<ul>
<li>
<dfn id="attr-server">server</dfn>
This attribute is set when an embedded server is available for use.
</li>
<li>
<dfn id="attr-features">features</dfn>
This attribute is used to hint what features a server supports.
</li>
</ul>
<h3 id="client-util">Client utilities</h2>
<ul>
<li>
<dfn id="util-stub">stub</dfn>
This utility acts as a server with test data for use during development and automated testing.
</li>
<li>
<dfn id="util-union">union</dfn>
This utility presents several servers as sub-folders.
</li>
<li>
<dfn id="util-sync">sync</dfn>
This utility lists two sub-folders and presents methods to copy missing files from one folder to the other.
</li>
</ul>
<h2 id="server">Server</h2>
<h3>Best Practices</h3>
Folders packages should follow these practices:
<ul>
<li>Support back-pressure for reasonable memory usage</li>
<li>Compatibility with common clients of the protocol</li>
<li>Present human-readable results as Markdown</li>
<li>Present machine readable objects as JSON</li>
<li>Launchable and controllable from the folders-cli project</li>
</ul>
<h3>Peering Protocols</h3>
Folders modules will often include full client and server sets for accessibility across existing software.
<p>A proof of concept for peering is included in the main project</p>
<p><dfn>HTTP Server-Sent Events</dfn> are a means of quickly sending and processing small amounts of data in web browsers.</p>
<p><dfn>tweetnacl</dfn> is a well-known library used to box and unbox messages when transmitting over insecure channels.</p>
<p>folders-http provides a proof of concept for web browsers to interface with the full toolkit</p>
<hr />
<h3 id="projects">Projects</h3>
<p>Currently in alpha state, these projects explore compatibility with common services. This projects are included in the
<a href="https://github.com/foldersjs/folders-cli">Folders CLI</a> development toolkit.
</p>
<ul>
<li>
<abbr title="File Transfer Protocol">FTP</abbr>: once ubiqituous on the Internet for uploading and downloading files, the FTP protocol is still widely used in academia and business.
(<a href="https://github.com/foldersjs/folders-ftp">folders-ftp</a>)
</li>
<li>
<abbr title="Secure Socket Shell">SSH</abbr>: providing encryption, the SSH ecosystem includes the spiritual successor to FTP, dubbed <abbr title="Secure File Transfer Protocol">SFTP</abbr> and a host of other networking features for the transfer of data and execution of commands in a reliable and trusted manner.
(<a href="https://github.com/foldersjs/folders-ssh">folders-ssh</a>)
</li>
<li>
<abbr title="Hypertext Transfer Protocol">HTTP</abbr>: the most common protocol for end-users, HTTP is a robust mechanism for transfering data and is most often used to serve websites. Data transferred over HTTP is often interpreted by a web browser or software service. The Folders HTTP project provides various client-server protocols currently in experimental state.
(<a href="https://github.com/foldersjs/folders-http">folders-http</a>)
</li>
</ul>
<ul>
<li>
<abbr title="Simple Storage Service">S3</abbr>: created by Amazon Web Services (AWS), this protocol is now widely supported by cloud providers for the storage and retrieval of objects over the HTTP protocol.
(<a href="https://github.com/foldersjs/folders-s3">folders-s3</a>)
</li>
<li>
<abbr title="Web Hadoop File System">WebHDFS</abbr>: from the Hadoop project, this protocol is served over HTTP and provides Hadoop ecosystem software efficient access to files and folders for big data processing. Hadoop projects may support the S3 protocol as well.
(<a href="https://github.com/foldersjs/folders-hdfs">folders-hdfs</a>)
</li>
</ul>
<ul>
<li>
<abbr title="Lightweight Directory Access Protocol">LDAP</abbr>: used by many corporations as part of their infrastructure, LDAP services maintain information about users and service accounts and the access to resources that they may be granted.
(<a href="https://github.com/foldersjs/folders-ldap">folders-ldap</a>)
</li>
</ul>
<ul>
<li>
Hive: created by Facebook, Hive is now commonly used in the big data ecosystem as a means for analyzing and transforming structured data sets.
(<a href="https://github.com/foldersjs/folders-hive">folders-hive</a>)
</li>
<li>
Presto: created by Facebook, Presto provides connections to multiple data systems (including Hive) for in-memory analysis and transformation of data sets
(<a href="https://github.com/foldersjs/folders-presto">folders-presto</a>)
</li>
</ul>
</p>
<hr />
</section>
</div>
<!-- FOOTER -->
<div id="footer_wrap" class="outer">
<footer class="inner">
<p>
<a href="#top">Top</a>
<span aria-hidden="true">·</span>
<a href="#folders">Introduction</a>
<span aria-hidden="true">·</span>
<a href="#projects">Projects</a>
<span aria-hidden="true">·</span>
<a href="#sdk">SDK</a>
<span style="float: right">(c) folders.io</span>
</p>
</footer>
</div>
</body>
</html>