Skip to content
This repository was archived by the owner on Nov 3, 2025. It is now read-only.

Commit df63df8

Browse files
authored
diagram / doc update (#55)
1 parent 5ccc910 commit df63df8

File tree

7 files changed

+15
-6
lines changed

7 files changed

+15
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
![SFM logo](docs/assets/images/sfm_logo.svg)
44

55

6-
Simple File Manager for Amazon EFS provides access to Amazon EFS through a RESTful API and responsive web app. Working together, these components enable the ability to manage data in an EFS filesystem from any location or device that can access the internet. A user can simply log-in to the Simple File Manager application from a web browser and directly upload, view, delete, or download their data in any Amazon EFS filesystem in their AWS account without needing to setup or maintain any dedicated EC2 or networking infrastructure.
6+
Simple File Manager for Amazon EFS provides access to Amazon EFS through a RESTful API and responsive web app. Together, these components allow you the ability to manage data in your Amazon EFS filesystem from any location or device that can access the internet. You simply log-in to the Simple File Manager application from a web browser and directly upload, view, delete, or download data from any filesystem in your AWS account. All without the need to setup or maintain any dedicated EC2 or networking infrastructure.
77

8-
You can deploy the open source solution by clicking a one-click deployment link in the install section below.
8+
You can deploy the open source solution by clicking one of the one-click deployment links in the install section below.
99

1010
***Note: This project is in an early beta stage. Please report bugs if you find them.***
1111

@@ -28,16 +28,16 @@ US West (Oregon) | [![Launch in us-west-2](docs/assets/images/launch-stack.png)]
2828
*During stack creation, you will have received an email containing your initial login credentials.*
2929

3030
5. Use the inital credentials to sign in. You will be required to create a new password.
31-
6. Upon successful authentication, the application will route you to the home page, where you will see all the EFS Filesystems in your account.
31+
6. Upon successful authentication, the application will route you to the home page, where you will see all the EFS Filesystems in your account for the selected region.
3232
7. To grant Simple File Manager access to a file system, click the link labeled "false". This will take you to the file manager lambda creation page.
33-
8. From the dropdown, select a mount target to connect the file manager lambda to. You can reference the network information for more details.
33+
8. In the form, fill out the required input fields. Leave them at their default values if you're unsure what the options are.
3434
9. Click submit and wait for the application to complete the request.
3535
10. After completion, you will be routed back to the home page.
3636

37-
*Currently there is a known issue where the link will initially still return "false". This is due to the fact lambda can take several minutes to replicate status across regions. Please allow 1-2 minutes if it still returns "false" and refresh the page.*
37+
*Lambda can take several minutes to provision a new function. Please allow 1-2 minutes if the managed state returns "Creating" and refresh the page.*
3838

3939
11. The link previously labeled false now returns true and the file system id is now a clickable link.
40-
12. Click on the file system link to access the file system.
40+
12. Click on the file system id link to access the file system.
4141

4242
The application will route you to the file system page, where you can now perform file system operations. The current supported operations are: *List*, *Make directory*, *Upload*, *Download*, and *Delete.*
4343

@@ -53,6 +53,12 @@ The cost to deploy and use the solution is minimal due to its serverless archite
5353

5454
**Admin Email**: The email address that will be used by the application Admin. The inital credentials will be sent to this address.
5555

56+
# Architecture
57+
58+
![SFM simple](docs/assets/images/simple_file_manager_simple.png)
59+
60+
*A detailed architecture diagram can be found in the docs directory*
61+
5662
___
5763

5864
Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile host="app.diagrams.net" modified="2021-04-26T18:27:01.530Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.128 Safari/537.36" etag="jofoBMjDusPUaGxGSp3k" version="14.6.6" type="device"><diagram id="qEy14C7cIk7G0RiGwj1F" name="Page-1">7Vhbc5s4FP41PJYBZC5+9CXpdqfd8ayn2+apo4AMagWHESI2/fUrgbC5GCdt4s1Od5MHo4Nu5/u+c6SDgVbp4S3HefIBIsIMx4oOBlobjuNYnid/lKVqLIHvN4aY06gx2SfDln4n2mhpa0kjUvQ6CgAmaN43hpBlJBQ9G+Yc9v1uO2D9VXMck5FhG2I2tn6ikUi0F651sv9GaJy0K9uWfpPitrM2FAmOYN8xoRsDrTiAaJ7Sw4owBV6LSzPuduLtcWOcZOIpAz4+3P2e/Um+fIa71R95/NfXIlu90bM8YFZqh/VmRdUiwKHMIqImsQ20xDzUJEmG0DLCRVK/U40dZWwFDLhsZ5DJTsuY44jKDQ7MheDw7QiohGKp90G4IIdJB+0jbFJvBFIieCW76AHID0x/3ozSanOQ9md/4s7xNCFJhzfUGrHWS3yc/gSpfNCo/gDCzuMI90BMRMo01lIxueqSHmIVXCbeF8gMGZTRAGzDQbdu4CJvGvHeGi8A9qzVeYt02+4g7TrngL4Szv4F4SqfgYsEYsgwew+Qa4S/EiEqrWdcCujjL6Hg1Wc9vm7cqYbpts31oftyXXVbG8Kp9IzwHuYkGqWbAeLSBSh5SC64inQexDwm4kK/2XkGOWFY0If+Pl6cjzaBd4Rvm7K9KEUiPaYhFkStm0Uqy0s/VGL/RrJixKPC7D2+lwdLjx3MaJzJ51DOplBeKj3LadlCv0hpFKk5lpwU9Du+r+dTVORAM1H76y4Nd30pIPSxogefknmXtmk5TkbPG8ucuXO7F0G69WR29OQb5Uxn5sEI2O0KBe6AzeOWfp7g4PHEppjb6qbOQ88Oyubo6GQ+q/57nQhzXzXCxoe3oyLs5hAmOItJJ6LkvYcbSrsek+4s72XDi9XT4tNWqZyT6BeJu+Bi3Fkmmnm9qGuS5M+H3fXjbP7fCyvvVcNqfGND9cEVhqRQsbSlac5UdN3S+ucDzmQVwOu7j7z6/FLhNH/sGEPW4MqNnhdP1dkB14su9PgpBqVgNJOx0VaYda0Dpyu2jBb5f6tWnbp+D27rx+79sDt3V2/lUEtnAwUVFJQs7kEISM/oRaiIH8uqIzm197aIc9q29lctiYu8cXRHD2ofjdIIv3kgjeAmipOZWRb1WpM6fHp9Ybv9+gK5+oLfqS98fQXp1het7cXTwmwklI9FHfQbAPY0zVyb1/P1IsQZrbP9QIOLtRcEy2nJjlTwAqzOgkHV6J6pGn3TPUfstQp0d0Tsu0gVKKL6n9xnkYs8+9XJ9UbkTp/ei827fzHVOKdfYlkz73E1pns9X/gz+x+m2/fM9mNu1ZrGSdpzzcAeMx78OOOyefpa2pz/p2/O6OZv</diagram></mxfile>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile host="app.diagrams.net" modified="2021-04-26T17:18:41.038Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.128 Safari/537.36" etag="r7NBnLPjrrGiHamqLHXT" version="14.6.1" type="device"><diagram id="uZ2j-mni5MrRXbtDEWrl" name="Page-1">7Vxbk5u4Ev418xgXQlwffRknqZNsTdXsbnbPi0sG2SbByAXyeLy/fgVIXCTwkDGM7ew4UxXUCEmo++v+Wgju4HT7/DFGu81X4uPwTtf85zs4u9N1HWiQ/ZdKjrnEhUYuWMeBn4tAKXgM/sFcqHHpPvBxUqtICQlpsKsLPRJF2KM1GYpjcqhXW5Gw3usOrXmPWil49FCIlWrfAp9ucqljVmp/wsF6I3oGGj+zRaIyFyQb5JNDRQTv7+A0JoTmR9vnKQ7TyRPzkl83bzlbDCzGEe1ywf/GaPbnRx19/H3925zMt+h78ukDb+UJhXt+w+Nvj0wwDcne5+OmRzEZOxJENJtQc8L+WH9T7c5kZ6ZpaaSbkkAu23UBUEtpG3WBXLbrAiA3D6T+gTzAikAp1ZrXpP61ygDZH5yQPQ2DCE8L09OYcB0jP2AqmZKQxEwWkYjN3mRDtyErAXZ42AQUP+6Ql87qgcGGyVYkotz4gS7KfOLTVpnx7NLj7fM6xdkIHRJjtI7Jfpd1+ZmZf+PZBTtceJkyWSM0Jj+wGNidDtm/eWosk1UQhtKAn3BMA4aDcRis07YpSbtCvBTiFU1bZHcRROsvWWkGNT7ypi58lGywz29HtV1hiKxX/FwRcVv+iMkW0/jIqgjXYnNcccfi8OKhRCmwhBfZVCDqGFyIuGtYF22X6GEHHEA/ASaoK2hSICR0FqIlDh9IEtCAVCZUzPoX6fQ28P20iUIBcX5DipqKilULSq2O9Rv5r1BA4VrRMqx6ylbFAAjrmgG6qhrDbtCMbQ2lGV31c4pmGjCgAMYcW1PHqlozaIWKDGEJGEVTqipOG9fLCKnP80ir/qy3nHZbmfX7+WO3qNIYWZqiS2OEUaNMrVrm9xt6kIVNMlsVArWaCBWqsEnWFBflq0HD1UC6uj0qtXllOVqxc5Y2htCunJsFMWso90MRiVPTqgWMtD3bBsBqQswq+8n+/0U31+rWZP9XiasvxVCU7PIJWQXP2G8LqjFOyD72cB5SJ6zYFFxxiBI2wAWbB7xIjgnF23an3j/C+VlDh43orjgAaI8Mw9VtE1o6BI5jqPhvqdK/E1a8wZ8P03eOefsc82nnNbJLw3GA0S+77JtFlvmaICuuSlZs2EBWLH2oqAksBSgPcfCEKE6Rsl9GmL6j5vZRk2BvHwf0uCgrP2YQEg3LeAKGfT8Zq8H33prrc6e/lK3op3ewQSlnM20VbHoT2AAcDGwqRx0/oYBF8iBkymFn/p+aia5NXpUwqHP56oShaEpmGR7TCI5PsKoloZRsK6ZQXNGHUnXJg5qmqlRDb1KqPVjeoWZ32F9jMbkphyVrEqHwvpRKCXJZ5wtJtZPp7Tum9MidAdpTUvceCUUxHadrjlWDYLJ5kA7/NIpy0nninpy8HmtvjU+xSJPTt/SGT+ovZhyWBk/1dc4mVfBLH9IQU+pdSvJdINHGfKD8olKfbH7QsVKNB67WboBlurWOxPLNvOWCD/K6UL0+O8iHUFpXMSevNzhHcSJM55jnBbIpnpWgcbvqln/xyj2nXjyQnJN5ZVrH8f0TzlkLaAukp/MrkQT24cYKPsftxjDtlKXIVNBR/ZgNh4pNsGNsGg8Ym4rgMVh4qtOUQWOTbl08NgHznd2/s/v/ArvXHffS7F48bH5bIsjmMD7+xa/PCn+nBWbSvDh7rp6cHaulBxwH7OZTF3gmYwRdKSNwB6GMP031ikjKDciC4CTVA1CsVTZfMAzXM8x3m3rZpkRQvbRNMV5XMxFovWRTunvqgmFsCjQnEEzyFUVozRSna1/QdoneIpmYaeYU2L9gMhGyGfTRYrWP+OOsQRMKIBmSYarphGWq0VDI+g+Gl3FczwH9q3RVrPS3cE3suPRaaeFYKfTos9yuPkvv22edlym4ilP4yrSROqvf81vp5Aw6AbbI8k6zzCI5qy57qVCDxfNRls0cSPxjkSF0lVFv2d3MTceERrt3as0n+wCpwb17wSA0NUG0GiirNZTSoXU9IAVvCFLBF24NpGLcbwHSHIutCzT/GZAWG8wuBlL7EiA9A1x6R3A514UtXcHW2PNwwvi+Vj5Y+JWW1vvY1dSZDq9xhGMULlA2pwuxyNh9F9MrkGw6r+LEYtm9dxMT2eGtINkQ70C8hGTjusKkGHcFyo/BdpeluEqmO374fMXUFu2CxRpRfEgXAZTc2R3bBmh3Lgpae0CVDQzxpErAylA3AloNT64cfWQNtdtP9HczyOoaI8F1BUkx7mqQTPGjfUIRCy5i5ci/laWjM+B6yZWjPgmvY8uPoo2Ro3cKlIMtHpk3RnkNuyOczd4Xqs9zm+AXnWfBAK5kng113983vGSCx/yObyOzuEpnudx7PzBdHAK6WZDld9ZKothoD14SOpKXNJwRVL2k/ZbphKE+x8nepF3FJFsSmgVM18Fyn6nveimuV465eSXIajfyup6VbQ75eyo9pZPyli1Da4qTtjVqsAF3qF1b5kWI75U8Hza7LuOa1xUOTHUZ948kI88PhIRJj1jtexHXI+soyKxBAup4ZjnO5HygDsl0oe1mm8MqIAYNi7tvjWD3tjiY2XVRyLyuRSFTXRSaYx/HiLJ51LXPPpsJZnX4HX4Dwc+UAugVYE88x7kZ7HVdNhrovYyf3RBlG/VdKQD83OsUUv1htkOJSa04hs/jr928wHk52dQGEMzPysmuc+8TxdsdiVF8LHcmezHOPCwKFQgNuC/KBrLPaXzPwlZ9zmBZm3mRjVG118W8ECVJ4N3V3xg70zUZHV2TWAu5FlpgtHDxLvBvg7n08RXDnFhGG8wln+DYLnCt/uE/2Ccs2PD37MZQOqKFj58CL/2CWqOvOA37/p78fgCwvofDEOSv+r0mrWETx2BvV1nXxfKHfl/TtoD0lJC53pHlVr4eIj07yB2M8gZnh5YNUx85wC1/3d4N7Ys+2NfFIQfXLLSU+ddOzn9nzSotM/530mZerVlWLD+FmFcvPygJ7/8F</diagram></mxfile>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<mxfile host="app.diagrams.net" modified="2021-04-26T17:16:35.210Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.128 Safari/537.36" etag="jq0e3c2PLUHyr2awNKcI" version="14.6.1" type="device"><diagram id="uZ2j-mni5MrRXbtDEWrl" name="Page-1">7Zltc6M2EIB/jT/Wg3j3RwfbyU1zbWbc3rX94lFAxroTyAPyW399JRCvErFzsXPXTh3PhF1kadndZ7XAyAqS430Gt5uPNEJkZBrRcWTNRqYJLMPi/4TmVGomll0q4gxHclCjWOK/kVQaUrvDEco7AxmlhOFtVxnSNEUh6+hgltFDd9iaku6qWxjLFY1GsQwhQcqwzzhim1LrO63RDwjHm2plYMgzCawGS0W+gRE9tFTWfGQFGaWsPEqOASLCeZVfyt8tBs7WhmUoZZf84OcpnH26N+H9b/EvC7pI4Jf84Sc5yx6Snbzg6eclVwSE7iJpNztVzthSnLLCoc4d//L1AmPk8DOBkMam01P0Za+rAKok5ugq+rLXVYD+9KC3Pugb2FIoUmd6o7e+0TKQf607umMEpyioU8/gyjiDEeYhCSihGdelNOXeu9uwhHAJ8MPDBjO03MJQePXAseG6NU2ZTH5gVrJ0vJiVJ89WHCfHWHA2hofcHscZ3W2LJT/w9NeeXfHDVVgEk0/CMvoVVYaNTIv/LUSy3K0xIT2D9yhjmHMwJTgWczMqloJSImjNxIz8KnAaPxbSzDKk5bolIphvUCQvR83dKhH5qujYUslcvkc0QSw78SHVWcOXYMnKYlWgHVqcVjRuWoxarlRCWRvievIGH34gCXoFTZap4KQwVAWNwGdEnmiOGaYtj1Zuf+ydTnAUiSnqCGTlBSlxqge2U0ikHV83jb4hAnVthc+kXSqHI+Ma3cgAV42MaRR49mPj3iw2plrqlNhoMFCYcaZu4LvthAaXRkGDRz3btdJBjevLmXqet1MdMF0Q1RCa/hVC+BjkfvCA/b9M88OvGWDpV3TQbFbzxVIJorYqd6rPWacORrPv7VZV11Roa4zWea+68pjPDce0reGtopciRvERi+fb8oLW+CiuZShnBjm+MCuGwfa6XOtSwtJibXljw78V2EpWfHoK/m9d/v2ty34bapsW2/eBfd2m5erNSd2MSFRsDSoO0FVP41YboK9wssAE5aecoeSyIjrU2g3VsW7ZMz0PAFeJqBx85QItQ91K3XNpqlTXomKgbL5HZeEYKPL2mF8nWkk/qkV5eGN+fVa5LuhmleNX1baVV56vppVn3WhPtpTUQRG/gZYizdiGxjSFZN5oe51oM+aRClwLR39BjJ1kuOCOUTWWuh2ytEUYMLjvSVVOd1mIXqAFSCcymMXopT3T14csQwQyvO8acnWmgR5qrvkIUxijjB89wuQZvgfgM8MJgPcmwJ8pYzQ5W8hDJMh8L74Jd2AEV+tdGpZmKozX9lwDcpsXyS7kEx3kmr3Du1Xj7fxHIberJ4rnIAfflXJbvfFZ4mRbcK7gPn36cMVbojcAqb0hglu8iiFDB3jSFJDJ1LPBcL1REL4GbsDudWqOOfZdhTdXs6n65ti1b4ScrYT8R2KQ+zs7/SHmHVtOJf9ZyLU4O8p1S+nUlp5QhrmfRMpIZTQVD+ubWHMNT23Sacmvw/ylG7s9kDjvxLy6sxfP5NcZDwnXzzDfZfHzruD0x+U9bGxWcF84vmO5w7h3s1e5D+xtCG+qApN+EbA9XRHwXN3DjckVemttDjjfZd/NORmsojEkMM9xWKklkuAlr58l0LEvJdDXcv8GJOVPn0Tr10Tf6r1JsH1vbBvNpzdhabecoxfi2qg3RF0t/b/nYmu/BPLLHik6tnPn2kOdeg9T35uAifsOBeTVHby2W+fG7/hlQWHPKkJ7HIrXx9puv4vKLZt6z+g3Gd646iha9QXonqd/w607F5v3ymVeNm/nrfk/</diagram></mxfile>
29.1 KB
Loading
118 KB
Loading
35.7 KB
Loading

0 commit comments

Comments
 (0)