You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/webviewer/deployment-methods.mdx
+26-31Lines changed: 26 additions & 31 deletions
Original file line number
Diff line number
Diff line change
@@ -9,16 +9,11 @@ There are many ways to deploy WebViewer code to your FileMaker file, and each me
9
9
10
10
This technique stores the WebViewer code as **data** directly in your FileMaker file. This is the default method for most WebViewer integrations and the method used when setting up a new project with the ProofKit CLI.
11
11
12
-
#### Pros
13
-
14
-
- Simple to setup and understand
15
-
- Works offline
16
-
17
-
#### Cons
18
-
19
-
- Doesn't survive data migrations
20
-
- Unable to use server-side JavaScript libraries
21
-
- Updates requires the web developer to have access to the FileMaker file
| ✅ Simple to setup and understand | ⚠️ Doesn't survive data migrations |
15
+
| ✅ Works offline | ⚠️ Unable to use server-side JavaScript libraries |
16
+
|| ⚠️ Updates requires the web developer to have access to the FileMaker file |
22
17
23
18
#### Considerations
24
19
@@ -36,17 +31,11 @@ To get around the data migration issue, you have a few options:
36
31
37
32
In the other extreme, you can host the WebViewer code like you would any other web application. If you're only using the @proofkit/webviewer library, you can still do this without any security concerns because the data won't load unless the web page is loaded in your FileMaker solution in a WebViewer.
38
33
39
-
#### Pros
40
-
41
-
- Code survives data migrations
42
-
- Can use server-side JavaScript libraries
43
-
- Can deploy updates to the web code without a data migration
44
-
45
-
#### Cons
46
-
47
-
- Requires a web server, or hosting account with Vercel (or similar)
48
-
- Code is de-coupled from the FileMaker file, which may cause schema to be out of sync if you're not careful
| ✅ Code survives data migrations | ⚠️ Requires a web server, or hosting account with Vercel (or similar) |
37
+
| ✅ Can use server-side JavaScript libraries | ⚠️ Code is de-coupled from the FileMaker file, which may cause schema to be out of sync if you're not careful |
38
+
| ✅ Can deploy updates to the web code without a data migration | ⚠️ Requires a persistent internet connection |
50
39
51
40
#### Implementation
52
41
@@ -66,13 +55,19 @@ Alternatively, you can just install the `@proofkit/webviewer` library into a sta
66
55
67
56
This technique is a hybrid of the embedded and hosted methods. Essentially, the code is embedded in the FileMaker file, but you also host a copy of it on another web server. The FileMaker file (or the web code) can check for updates and download the latest version directly to the the neccesary field.
68
57
69
-
#### Pros
70
-
71
-
- Enables a self-updating solution
72
-
- Great for non-hosted files, or a vertical-market solution where each copy may need a different version of the WebViewer code
73
-
- Can work offline, after the initial download
74
-
75
-
#### Cons
76
-
77
-
- Requires a server to host a copy of the code (but can be a simple static file host or CDN)
| ✅ Enables a self-updating solution | ⚠️ Requires a server to host a copy of the code (but can be a simple static file host or CDN) |
61
+
| ✅ Great for non-hosted files, or a vertical-market solution where each copy may need a different version of the WebViewer code | ⚠️ More complex to setup and maintain |
62
+
| ✅ Can work offline, after the initial download ||
The goal of this package is to make it easy to work with FileMaker scripts and data when building a custom webviewer integration. @proofkit/webviewer works only inside of webviewer and allows you to interact with your FileMaker solution via local scripts.
13
13
14
-
This is a **client-side** package, meant to run specifically in a FileMaker WebViewer, but it can still be used in a hosted web app, such as Next.js. However, it will cause errors if loaded in a standard browser. For more information about deployment strategies, see the [Deployment](/docs/deployment) page.
14
+
This is a **client-side** package, meant to run specifically in a FileMaker WebViewer, but it can still be used in a hosted web app, such as Next.js. However, it will cause errors if loaded in a standard browser. For more information about deployment strategies, see the [Deployment](/docs/cli/webviewer/deployment-methods) guide (from the CLI docs).
15
15
16
16
For web-based applications where you're looking to interact with the Data API using a network request, check out the [@proofkit/fmdapi](/docs/fmdapi) package instead.
0 commit comments