jjkiers/cloudron-box
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Add readonlyRootfs flag to apps table

Browse Source 
When turned off, it will put the app in a writable rootfs. This
allows us to debug live/production apps (like change start.sh) and
just get them up and running. Once turned off, this app cannot be
updated anymore (unless the force flag is set). This way we can
then update it using the CLI if we are convinced that the upcoming
update fixes the problem.

Part of #171
This commit is contained in:
Girish Ramakrishnan
2017-01-19 11:20:24 -08:00
parent 02f0bb3ea5
commit 7ef6bd0d3f
7 changed files with 29 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/references/api.md
View File

@@ -118,7 +118,8 @@ Request:
key: <string>, // pem encoded TLS key
memoryLimit: <number>, // memory constraint in bytes
altDomain: <string>, // alternate domain from which this app can be reached
xFrameOptions: <string> // set X-Frame-Options header, to control which websites can embed this app
xFrameOptions: <string>, // set X-Frame-Options header, to control which websites can embed this app
readonlyRootfs: <boolean> // whether the app's rootfs is readonly
}
```
@@ -151,6 +152,9 @@ If `altDomain` is set, the app can be accessed from `https://<altDomain>`.
* `SAMEORIGIN` - allows embedding from the same domain as the app. This is the default.
* `ALLOW-FROM https://example.com/` - allows this app to be embedded from example.com
If `readonlyRootfs` is false, then the app's rootfs can be modified post installation. This is useful for debugging as it allows the app's code to be modified post installation. Apps that have a readonly rootfs cannot
be updated to a newer version (because it is not safe to update them).
Read more about the options at [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options).
Response (200):
@@ -464,7 +468,8 @@ Request:
key: <string>, // pem encoded TLS key
memoryLimit: <number>, // memory constraint in bytes
altDomain: <string>, // alternate domain from which this app can be reached
xFrameOptions: <string> // set X-Frame-Options header, to control which websites can embed this app
xFrameOptions: <string>, // set X-Frame-Options header, to control which websites can embed this app
readonlyRootfs: <boolean> // whether the app's rootfs is readonly
```
All values are optional. See [Install app](/references/api.html#install-app) API for field descriptions.