Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
divviup",id:"install-divviup",level:3},{value:"Download compose.yaml",id:"download-composeyaml",level:3},{value:"Start Divvi Up",id:"start-divvi-up",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,a.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"command-line-tutorial",children:"Command Line Tutorial"}),"\n",(0,i.jsxs)(n.p,{children:["Learn Divvi Up via a local instance of all Divvi Up components running via\n",(0,i.jsx)(n.code,{children:"docker compose"}),"."]}),"\n",(0,i.jsx)(n.p,{children:"Following this tutorial will:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Install required software and tools"}),"\n",(0,i.jsx)(n.li,{children:"Run Divvi Up and a pair of aggregators locally in Docker"}),"\n",(0,i.jsx)(n.li,{children:"Shard some measurements into reports and upload them, simulating DAP clients"}),"\n",(0,i.jsx)(n.li,{children:"Collect the results of an aggregation"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["If any of these terms are unfamiliar please read the\n",(0,i.jsx)(n.a,{href:"./how-it-works",children:"How it Works"})," doc."]}),"\n",(0,i.jsx)(n.h2,{id:"requirements",children:"Requirements"}),"\n",(0,i.jsx)(n.p,{children:"To get started, you'll need:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"A Unix like shell on macOS, Linux or Windows"}),"\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.code,{children:"divviup"})," binary (see instructions below)"]}),"\n",(0,i.jsxs)(n.li,{children:["A ",(0,i.jsx)(n.code,{children:"compose.yaml"})," (see instructions below)"]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})," and\n",(0,i.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"}),"."]}),"\n"]}),"\n",(0,i.jsxs)(n.h3,{id:"install-divviup",children:["Install ",(0,i.jsx)(n.code,{children:"divviup"})]}),"\n",(0,i.jsxs)(n.p,{children:[(0,i.jsx)(n.code,{children:"divviup"})," is a command line (CLI) tool for doing basic operations on the Divvi\nUp and Distributed Aggregation Protocol (DAP) API endpoints. See\n",(0,i.jsx)(n.code,{children:"divviup --help"})," for details on all of the commands."]}),"\n",(0,i.jsxs)(n.p,{children:["The tool is available for download for macOS, Windows or Linux from the\n",(0,i.jsx)(n.a,{href:"https://github.com/divviup/divviup-api/releases",children:"divviup-api releases page"}),"."]}),"\n",(0,i.jsxs)(n.h3,{id:"download-composeyaml",children:["Download ",(0,i.jsx)(n.code,{children:"compose.yaml"})]}),"\n",(0,i.jsxs)(n.p,{children:["A ",(0,i.jsx)(n.code,{children:"compose.yaml"})," will be used to download and run all required containers to run\na Divvi Up environment."]}),"\n",(0,i.jsx)(n.p,{children:"Create a folder for this tutorial"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"mkdir divviup-tutorial\ncd divviup-tutorial\n"})}),"\n",(0,i.jsxs)(n.p,{children:["And download the latest release of the ",(0,i.jsx)(n.code,{children:"compose.yaml"})," found on the\n",(0,i.jsx)(n.a,{href:"https://github.com/divviup/divviup-api/releases",children:"divviup-api releases page"}),"\npage."]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"curl -L https://github.com/divviup/divviup-api/releases/latest/download/compose.yaml > compose.yaml\n"})}),"\n",(0,i.jsx)(n.h2,{id:"start-divvi-up",children:"Start Divvi Up"}),"\n",(0,i.jsxs)(n.p,{children:["First, get Divvi Up running locally. In your shell, navigate to the directory\ncontaining ",(0,i.jsx)(n.code,{children:"compose.yaml"})," and run:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"docker compose up --wait\n"})}),"\n",(0,i.jsx)(n.p,{children:"This will:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"deploy two Janus aggregators to act as leader and helper in your tasks"}),"\n",(0,i.jsx)(n.li,{children:"deploy the Divvi Up control plane to coordinate the aggregators"}),"\n",(0,i.jsx)(n.li,{children:"pair the aggregators with the control plane to make them available for use in\ntask definitions"}),"\n",(0,i.jsx)(n.li,{children:'create an account named "demo"'}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["Set an environment variable to direct ",(0,i.jsx)(n.code,{children:"divviup"})," to use your local control plane\nand to use an empty API token:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'export DIVVIUP_API_URL=http://localhost:8080\nexport DIVVIUP_TOKEN=""\n'})}),"\n",(0,i.jsx)(n.p,{children:"Next, obtain the ID of the demo account:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"divviup account list\n"})}),"\n",(0,i.jsx)(n.p,{children:'You should get a single account back with the name "demo", like this:'}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'[\n {\n "id": "8ea1fc65-a669-48dd-96ac-c920fcb0ae90",\n "name": "demo",\n "created_at": "2024-06-14T22:48:00.683659Z",\n "updated_at": "2024-06-14T22:48:00.683659Z",\n "admin": false\n }\n]\n'})}),"\n",(0,i.jsx)(n.p,{children:"Now, set an environment variable for the account ID:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# Substitute the account ID that was generated by your Divvi Up instance\nexport DIVVIUP_ACCOUNT_ID=8ea1fc65-a669-48dd-96ac-c920fcb0ae90\n"})}),"\n",(0,i.jsx)(n.p,{children:"List the aggregators and identify the ID of both a leader and a helper."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"divviup aggregator list\n"})}),"\n",(0,i.jsx)(n.p,{children:"The output will contain JSON objects like:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:' {\n "id": "3650870b-56e6-4eac-8944-b7ca36569b33",\n "role": "Either",\n "name": "Divvi Up staging-dap-09-1",\n "dap_url": "https://staging-dap-09-1.api.example.com/",\n "api_url": "https://staging-dap-09-1.api.example.com/aggregator-api",\n "is_first_party": true,\n "vdafs": [\n "Prio3Count",\n "Prio3Sum",\n "Prio3Histogram",\n "Prio3SumVec"\n ],\n "query_types": [\n "TimeInterval",\n "FixedSize"\n ],\n "protocol": "DAP-09",\n "features": [\n "TokenHash",\n "TimeBucketedFixedSize",\n "UploadMetrics"\n ]\n },\n {\n "id": "96301951-c848-4a57-b4f5-32812e4db1be",\n "account_id": null,\n "created_at": "2024-03-21T22:47:15.467139Z",\n "updated_at": "2024-04-18T17:33:30.439465Z",\n "deleted_at": null,\n "role": "Either",\n "name": "Divvi Up staging-dap-09-2",\n "dap_url": "https://staging-dap-09-2.api.example.com/",\n "api_url": "https://staging-dap-09-2.api.example.com/aggregator-api",\n "is_first_party": false,\n "vdafs": [\n "Prio3Count",\n "Prio3Sum",\n "Prio3Histogram",\n "Prio3SumVec"\n ],\n "query_types": [\n "TimeInterval",\n "FixedSize"\n ],\n "protocol": "DAP-09",\n "features": [\n "TokenHash",\n "UploadMetrics",\n "TimeBucketedFixedSize"\n ]\n }\n'})}),"\n",(0,i.jsx)(n.p,{children:"Set the two IDs into environment variables. NOTE: These IDs will vary based on\nyour configuration."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# Substitute the leader and helper aggregator IDs that were generated by your Divvi Up instance\nexport LEADER_ID=3650870b-56e6-4eac-8944-b7ca36569b33\nexport HELPER_ID=96301951-c848-4a57-b4f5-32812e4db1be\n"})}),"\n",(0,i.jsx)(n.p,{children:"Next, generate a collector-credential for the task. The collector credential\nwill be used by the collector to export the aggregated statistics."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"divviup collector-credential generate --save\n"})}),"\n",(0,i.jsx)(n.p,{children:"The output will be like:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:'{\n "id": "0a0f8ea8-b603-4416-b138-b7f217153bb7",\n "hpke_config": {\n "id": 144,\n "kem_id": "X25519HkdfSha256",\n "kdf_id": "HkdfSha256",\n "aead_id": "Aes128Gcm",\n "public_key": "V9IpdJxS91MHPiNTjwDk9DFS-5M_neVrPxlmvolmTTo"\n },\n "created_at": "2024-05-03T15:23:56.624726Z",\n "deleted_at": null,\n "updated_at": "2024-05-03T15:23:56.624727Z",\n "name": "collector-credential-144",\n "token_hash": "VItYJdAyWYIvooe8GzkGnVTvaMkvWc9G-eiwxudfWww",\n "token": "A6JDAYPiYDXmNyh-OpYXGw"\n}\n\nSaved new collector credential to /your/current/directory/collector-credential-144.json. Keep this file safe!\n'})}),"\n",(0,i.jsx)(n.admonition,{type:"warning",children:(0,i.jsx)(n.p,{children:"This credential isn't sensitive because it's only useful in your local instance\nof Divvi Up. But collector credentials generated against the production service\nshould be carefully managed. Consider using a password manager to protect them."})}),"\n",(0,i.jsx)(n.p,{children:"Make a note of the path where the credential was saved, and save the collector\ncredential ID to an environment variable."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# Substitute the collector credential path and ID that were generated by your Divvi Up instance\nexport COLLECTOR_CREDENTIAL_PATH=/your/current/directory/collector-credential-144.json\nexport COLLECTOR_CREDENTIAL_ID=0a0f8ea8-b603-4416-b138-b7f217153bb7\n"})}),"\n",(0,i.jsx)(n.p,{children:"Create the the histogram task. In this case the task is a set of values from 0\nto 10 for use in collecting a net-promoter score for a survey."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:" divviup task create --name net-promoter-score \\\n --leader-aggregator-id $LEADER_ID --helper-aggregator-id $HELPER_ID \\\n --collector-credential-id $COLLECTOR_CREDENTIAL_ID \\\n --vdaf histogram --categorical-buckets 0,1,2,3,4,5,6,7,8,9,10 \\\n --min-batch-size 100 --max-batch-size 200 --time-precision 60sec\n"})}),"\n",(0,i.jsx)(n.p,{children:"The output will contain a JSON object:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "id": "Siwa4QTEnQXMfRPyhir8AzS4EBqfTebmEzKfvajDgYk",\n "account_id": "a9c571ba-5f3d-4814-8d8b-c5bb0f5030b7",\n "name": "net-promoter-score",\n "vdaf": {\n "type": "histogram",\n "buckets": ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"],\n "chunk_length": 4\n },\n "min_batch_size": 100,\n "max_batch_size": null,\n "created_at": "2024-05-03T15:27:56.229891Z",\n "updated_at": "2024-05-03T15:27:56.229891Z",\n "time_precision_seconds": 60,\n "report_count": 0,\n "aggregate_collection_count": 0,\n "expiration": "2025-05-03T15:27:55.88511Z",\n "leader_aggregator_id": "3650870b-56e6-4eac-8944-b7ca36569b33",\n "helper_aggregator_id": "96301951-c848-4a57-b4f5-32812e4db1be",\n "collector_credential_id": "0a0f8ea8-b603-4416-b138-b7f217153bb7",\n "report_counter_interval_collected": 0,\n "report_counter_decode_failure": 0,\n "report_counter_decrypt_failure": 0,\n "report_counter_expired": 0,\n "report_counter_outdated_key": 0,\n "report_counter_success": 0,\n "report_counter_too_early": 0,\n "report_counter_task_expired": 0\n}\n'})}),"\n",(0,i.jsx)(n.p,{children:"Save the ID of the task into an environment variable."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"# Substitute the task ID that was generated by your Divvi Up instance\nexport TASK_ID=Siwa4QTEnQXMfRPyhir8AzS4EBqfTebmEzKfvajDgYk\n"})}),"\n",(0,i.jsx)(n.p,{children:"Upload a random set of 150 metrics."}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"for i in {1..150}; do\n measurement=$(( $RANDOM % 10 ))\n divviup dap-client upload --task-id $TASK_ID --measurement $measurement;\ndone\n"})}),"\n",(0,i.jsx)(n.p,{children:"Wait a little while to let the aggregators run the aggregation jobs. Then, get\ncollection results:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"divviup dap-client collect \\\n --task-id $TASK_ID \\\n --collector-credential-file $COLLECTOR_CREDENTIAL_PATH \\\n --current-batch\n"})}),"\n",(0,i.jsx)(n.p,{children:"You will get a result like:"}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-sh",children:"Number of reports: 113\nInterval start: 2024-06-05 21:31:00 UTC\nInterval end: 2024-06-05 21:34:00 UTC\nInterval length: 180s\nAggregation result: [14, 10, 10, 13, 13, 8, 16, 13, 9, 7, 0]\ncollection: Collection { partial_batch_selector: PartialBatchSelector { batch_identifier: BatchId(wPLBlC6iHWp_YBBAYP_ig5nal0FOz1QlLSaC42U7sm0) }, report_count: 113, interval: (2024-06-05T21:31:00Z, TimeDelta { secs: 180, nanos: 0 }), aggregate_result: [14, 10, 10, 13, 13, 8, 16, 13, 9, 7, 0] }\n"})}),"\n",(0,i.jsx)(n.p,{children:'If you get an error like "The batch implied by the query is invalid", then the\naggregators are still working on processing your uploaded reports. Given them a\nfew more minutes.'}),"\n",(0,i.jsx)(n.p,{children:"If you get fewer reports in the collection than you uploaded, that's because you\nsent the collection request too soon and not all the reports were prepared yet.\nThose reports will be available in a later collection, after enough additional\nreports are uploaded to meet the minimum batch size."}),"\n",(0,i.jsxs)(n.p,{children:["Congratulations! You've just used secure multi-party computation to do a\nprivacy-preserving aggregation over secret shares of measurements. Now you can\ntry experimenting with different tasks. Try creating different histograms with\ndifferent numbers of buckets, or see if you can use ",(0,i.jsx)(n.code,{children:"Prio3SumVec"})," to compute\nsums over bit vectors."]})]})}function h(e={}){const{wrapper:n}={...(0,a.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(d,{...e})}):d(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>s,a:()=>o});var i=t(7294);const a={},r=i.createContext(a);function o(e){const n=i.useContext(r);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function s(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(a):e.components||a:o(e.components),i.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/d62d0f31.5d3178a7.js b/assets/js/d62d0f31.5d3178a7.js
new file mode 100644
index 0000000..0b62f7d
--- /dev/null
+++ b/assets/js/d62d0f31.5d3178a7.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunkpublic_docs=self.webpackChunkpublic_docs||[]).push([[474],{2352:(e,n,t)=>{t.r(n),t.d(n,{assets:()=>s,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>l,toc:()=>c});var a=t(5893),i=t(1151);const r={sidebar_position:3,title:"Command Line Tutorial"},o="Divvi Up Command Line Tutorial",l={id:"command-line-tutorial",title:"Command Line Tutorial",description:"Learn Divvi Up via a local instance of all Divvi Up components running via",source:"@site/docs/command-line-tutorial.md",sourceDirName:".",slug:"/command-line-tutorial",permalink:"/command-line-tutorial",draft:!1,unlisted:!1,editUrl:"https://github.com/divviup/public-docs/tree/main/docs/command-line-tutorial.md",tags:[],version:"current",sidebarPosition:3,frontMatter:{sidebar_position:3,title:"Command Line Tutorial"},sidebar:"docSidebar",previous:{title:"How It Works",permalink:"/how-it-works"},next:{title:"Video Demo",permalink:"/command-line-video-demo"}},s={},c=[{value:"Requirements",id:"requirements",level:2},{value:"Install divviup",id:"install-divviup",level:3},{value:"Download compose.yaml",id:"download-composeyaml",level:3},{value:"Start Divvi Up",id:"start-divvi-up",level:2},{value:"Configure Auth",id:"configure-auth",level:2},{value:"Configure Leader and Helper Aggregator",id:"configure-leader-and-helper-aggregator",level:2},{value:"Collector Credential",id:"collector-credential",level:2},{value:"Create a Task",id:"create-a-task",level:2},{value:"Upload Measurement Reports",id:"upload-measurement-reports",level:2},{value:"Collect the Aggregated Value",id:"collect-the-aggregated-value",level:2},{value:"Next Steps",id:"next-steps",level:2}];function d(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.a)(),...e.components};return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(n.h1,{id:"divvi-up-command-line-tutorial",children:"Divvi Up Command Line Tutorial"}),"\n",(0,a.jsxs)(n.p,{children:["Learn Divvi Up via a local instance of all Divvi Up components running via\n",(0,a.jsx)(n.code,{children:"docker compose"}),"."]}),"\n",(0,a.jsx)(n.p,{children:"Following this tutorial will:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"Install required software and tools"}),"\n",(0,a.jsx)(n.li,{children:"Run Divvi Up and a pair of aggregators locally in Docker"}),"\n",(0,a.jsx)(n.li,{children:"Shard some measurements into reports and upload them, simulating DAP clients"}),"\n",(0,a.jsx)(n.li,{children:"Collect the results of an aggregation"}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["If any of these terms are unfamiliar please read the\n",(0,a.jsx)(n.a,{href:"./how-it-works",children:"How it Works"})," doc."]}),"\n",(0,a.jsx)(n.h2,{id:"requirements",children:"Requirements"}),"\n",(0,a.jsx)(n.p,{children:"To get started, you'll need:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"A Unix like shell on macOS, Linux or Windows"}),"\n",(0,a.jsxs)(n.li,{children:["A ",(0,a.jsx)(n.code,{children:"divviup"})," binary (see instructions below)"]}),"\n",(0,a.jsxs)(n.li,{children:["A ",(0,a.jsx)(n.code,{children:"compose.yaml"})," (see instructions below)"]}),"\n",(0,a.jsxs)(n.li,{children:[(0,a.jsx)(n.a,{href:"https://docs.docker.com/get-docker/",children:"Docker"})," and\n",(0,a.jsx)(n.a,{href:"https://docs.docker.com/compose/install/",children:"Docker Compose"}),"."]}),"\n"]}),"\n",(0,a.jsxs)(n.p,{children:["If you are unable to meet these requirements or would prefer to watch this\ntutorial being performed as a video see the\n",(0,a.jsx)(n.a,{href:"./command-line-video-demo",children:"command line video demo"})]}),"\n",(0,a.jsxs)(n.h3,{id:"install-divviup",children:["Install ",(0,a.jsx)(n.code,{children:"divviup"})]}),"\n",(0,a.jsxs)(n.p,{children:[(0,a.jsx)(n.code,{children:"divviup"})," is a command line (CLI) tool for doing basic operations on the Divvi\nUp and Distributed Aggregation Protocol (DAP) API endpoints. See\n",(0,a.jsx)(n.code,{children:"divviup --help"})," for details on all of the commands."]}),"\n",(0,a.jsxs)(n.p,{children:["The tool is available for download for macOS, Windows or Linux from the\n",(0,a.jsx)(n.a,{href:"https://github.com/divviup/divviup-api/releases",children:"divviup-api releases page"}),"."]}),"\n",(0,a.jsxs)(n.h3,{id:"download-composeyaml",children:["Download ",(0,a.jsx)(n.code,{children:"compose.yaml"})]}),"\n",(0,a.jsxs)(n.p,{children:["A ",(0,a.jsx)(n.code,{children:"compose.yaml"})," will be used to download and run all required containers to run\na Divvi Up environment."]}),"\n",(0,a.jsx)(n.p,{children:"Create a folder for this tutorial"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"mkdir divviup-tutorial\ncd divviup-tutorial\n"})}),"\n",(0,a.jsxs)(n.p,{children:["And download the latest release of the ",(0,a.jsx)(n.code,{children:"compose.yaml"})," found on the\n",(0,a.jsx)(n.a,{href:"https://github.com/divviup/divviup-api/releases",children:"divviup-api releases page"}),"\npage."]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"curl -L https://github.com/divviup/divviup-api/releases/latest/download/compose.yaml > compose.yaml\n"})}),"\n",(0,a.jsx)(n.h2,{id:"start-divvi-up",children:"Start Divvi Up"}),"\n",(0,a.jsxs)(n.p,{children:["First, get Divvi Up running locally. In your shell, navigate to the directory\ncontaining ",(0,a.jsx)(n.code,{children:"compose.yaml"})," and run:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"docker compose up --wait\n"})}),"\n",(0,a.jsx)(n.p,{children:"This will:"}),"\n",(0,a.jsxs)(n.ul,{children:["\n",(0,a.jsx)(n.li,{children:"deploy two Janus aggregators to act as leader and helper in your tasks"}),"\n",(0,a.jsx)(n.li,{children:"deploy the Divvi Up control plane to coordinate the aggregators"}),"\n",(0,a.jsx)(n.li,{children:"pair the aggregators with the control plane to make them available for use in\ntask definitions"}),"\n",(0,a.jsx)(n.li,{children:'create an account named "demo"'}),"\n"]}),"\n",(0,a.jsx)(n.h2,{id:"configure-auth",children:"Configure Auth"}),"\n",(0,a.jsxs)(n.p,{children:["Set an environment variable to direct ",(0,a.jsx)(n.code,{children:"divviup"})," to use your local control plane\nand to use an empty API token:"]}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:'export DIVVIUP_API_URL=http://localhost:8080\nexport DIVVIUP_TOKEN=""\n'})}),"\n",(0,a.jsx)(n.p,{children:"Next, obtain the ID of the demo account:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"divviup account list\n"})}),"\n",(0,a.jsx)(n.p,{children:'You should get a single account back with the name "demo", like this:'}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'[\n {\n "id": "8ea1fc65-a669-48dd-96ac-c920fcb0ae90",\n "name": "demo",\n "created_at": "2024-06-14T22:48:00.683659Z",\n "updated_at": "2024-06-14T22:48:00.683659Z",\n "admin": false\n }\n]\n'})}),"\n",(0,a.jsx)(n.p,{children:"Now, set an environment variable for the account ID:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"# Substitute the account ID that was generated by your Divvi Up instance\nexport DIVVIUP_ACCOUNT_ID=8ea1fc65-a669-48dd-96ac-c920fcb0ae90\n"})}),"\n",(0,a.jsx)(n.h2,{id:"configure-leader-and-helper-aggregator",children:"Configure Leader and Helper Aggregator"}),"\n",(0,a.jsx)(n.p,{children:"List the aggregators and identify the ID of both a leader and a helper."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"divviup aggregator list\n"})}),"\n",(0,a.jsx)(n.p,{children:"The output will contain JSON objects like:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:' {\n "id": "3650870b-56e6-4eac-8944-b7ca36569b33",\n "role": "Either",\n "name": "Divvi Up staging-dap-09-1",\n "dap_url": "https://staging-dap-09-1.api.example.com/",\n "api_url": "https://staging-dap-09-1.api.example.com/aggregator-api",\n "is_first_party": true,\n "vdafs": [\n "Prio3Count",\n "Prio3Sum",\n "Prio3Histogram",\n "Prio3SumVec"\n ],\n "query_types": [\n "TimeInterval",\n "FixedSize"\n ],\n "protocol": "DAP-09",\n "features": [\n "TokenHash",\n "TimeBucketedFixedSize",\n "UploadMetrics"\n ]\n },\n {\n "id": "96301951-c848-4a57-b4f5-32812e4db1be",\n "account_id": null,\n "created_at": "2024-03-21T22:47:15.467139Z",\n "updated_at": "2024-04-18T17:33:30.439465Z",\n "deleted_at": null,\n "role": "Either",\n "name": "Divvi Up staging-dap-09-2",\n "dap_url": "https://staging-dap-09-2.api.example.com/",\n "api_url": "https://staging-dap-09-2.api.example.com/aggregator-api",\n "is_first_party": false,\n "vdafs": [\n "Prio3Count",\n "Prio3Sum",\n "Prio3Histogram",\n "Prio3SumVec"\n ],\n "query_types": [\n "TimeInterval",\n "FixedSize"\n ],\n "protocol": "DAP-09",\n "features": [\n "TokenHash",\n "UploadMetrics",\n "TimeBucketedFixedSize"\n ]\n }\n'})}),"\n",(0,a.jsx)(n.p,{children:"Set the two IDs into environment variables. NOTE: These IDs will vary based on\nyour configuration."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"# Substitute the leader and helper aggregator IDs that were generated by your Divvi Up instance\nexport LEADER_ID=3650870b-56e6-4eac-8944-b7ca36569b33\nexport HELPER_ID=96301951-c848-4a57-b4f5-32812e4db1be\n"})}),"\n",(0,a.jsx)(n.h2,{id:"collector-credential",children:"Collector Credential"}),"\n",(0,a.jsx)(n.p,{children:"Next, generate a collector-credential for the task. The collector credential\nwill be used by the collector to export the aggregated statistics."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"divviup collector-credential generate --save\n"})}),"\n",(0,a.jsx)(n.p,{children:"The output will be like:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:'{\n "id": "0a0f8ea8-b603-4416-b138-b7f217153bb7",\n "hpke_config": {\n "id": 144,\n "kem_id": "X25519HkdfSha256",\n "kdf_id": "HkdfSha256",\n "aead_id": "Aes128Gcm",\n "public_key": "V9IpdJxS91MHPiNTjwDk9DFS-5M_neVrPxlmvolmTTo"\n },\n "created_at": "2024-05-03T15:23:56.624726Z",\n "deleted_at": null,\n "updated_at": "2024-05-03T15:23:56.624727Z",\n "name": "collector-credential-144",\n "token_hash": "VItYJdAyWYIvooe8GzkGnVTvaMkvWc9G-eiwxudfWww",\n "token": "A6JDAYPiYDXmNyh-OpYXGw"\n}\n\nSaved new collector credential to /your/current/directory/collector-credential-144.json. Keep this file safe!\n'})}),"\n",(0,a.jsx)(n.admonition,{type:"warning",children:(0,a.jsx)(n.p,{children:"This credential isn't sensitive because it's only useful in your local instance\nof Divvi Up. But collector credentials generated against the production service\nshould be carefully managed. Consider using a password manager to protect them."})}),"\n",(0,a.jsx)(n.p,{children:"Make a note of the path where the credential was saved, and save the collector\ncredential ID to an environment variable."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"# Substitute the collector credential path and ID that were generated by your Divvi Up instance\nexport COLLECTOR_CREDENTIAL_PATH=/your/current/directory/collector-credential-144.json\nexport COLLECTOR_CREDENTIAL_ID=0a0f8ea8-b603-4416-b138-b7f217153bb7\n"})}),"\n",(0,a.jsx)(n.h2,{id:"create-a-task",children:"Create a Task"}),"\n",(0,a.jsx)(n.p,{children:"Create the the histogram task. In this case the task is a set of values from 0\nto 10 for use in collecting a net-promoter score for a survey."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:" divviup task create --name net-promoter-score \\\n --leader-aggregator-id $LEADER_ID --helper-aggregator-id $HELPER_ID \\\n --collector-credential-id $COLLECTOR_CREDENTIAL_ID \\\n --vdaf histogram --categorical-buckets 0,1,2,3,4,5,6,7,8,9,10 \\\n --min-batch-size 100 --max-batch-size 200 --time-precision 60sec\n"})}),"\n",(0,a.jsx)(n.p,{children:"The output will contain a JSON object:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-json",children:'{\n "id": "Siwa4QTEnQXMfRPyhir8AzS4EBqfTebmEzKfvajDgYk",\n "account_id": "a9c571ba-5f3d-4814-8d8b-c5bb0f5030b7",\n "name": "net-promoter-score",\n "vdaf": {\n "type": "histogram",\n "buckets": ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10"],\n "chunk_length": 4\n },\n "min_batch_size": 100,\n "max_batch_size": null,\n "created_at": "2024-05-03T15:27:56.229891Z",\n "updated_at": "2024-05-03T15:27:56.229891Z",\n "time_precision_seconds": 60,\n "report_count": 0,\n "aggregate_collection_count": 0,\n "expiration": "2025-05-03T15:27:55.88511Z",\n "leader_aggregator_id": "3650870b-56e6-4eac-8944-b7ca36569b33",\n "helper_aggregator_id": "96301951-c848-4a57-b4f5-32812e4db1be",\n "collector_credential_id": "0a0f8ea8-b603-4416-b138-b7f217153bb7",\n "report_counter_interval_collected": 0,\n "report_counter_decode_failure": 0,\n "report_counter_decrypt_failure": 0,\n "report_counter_expired": 0,\n "report_counter_outdated_key": 0,\n "report_counter_success": 0,\n "report_counter_too_early": 0,\n "report_counter_task_expired": 0\n}\n'})}),"\n",(0,a.jsx)(n.p,{children:"Save the ID of the task into an environment variable."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"# Substitute the task ID that was generated by your Divvi Up instance\nexport TASK_ID=Siwa4QTEnQXMfRPyhir8AzS4EBqfTebmEzKfvajDgYk\n"})}),"\n",(0,a.jsx)(n.h2,{id:"upload-measurement-reports",children:"Upload Measurement Reports"}),"\n",(0,a.jsx)(n.p,{children:"Upload a random set of 150 measurements."}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"for i in {1..150}; do\n measurement=$(( $RANDOM % 10 ))\n divviup dap-client upload --task-id $TASK_ID --measurement $measurement;\ndone\n"})}),"\n",(0,a.jsx)(n.p,{children:"Wait a little while to let the aggregators run the aggregation jobs. Then, get\ncollection results:"}),"\n",(0,a.jsx)(n.h2,{id:"collect-the-aggregated-value",children:"Collect the Aggregated Value"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"divviup dap-client collect \\\n --task-id $TASK_ID \\\n --collector-credential-file $COLLECTOR_CREDENTIAL_PATH \\\n --current-batch\n"})}),"\n",(0,a.jsx)(n.p,{children:"You will get a result like:"}),"\n",(0,a.jsx)(n.pre,{children:(0,a.jsx)(n.code,{className:"language-sh",children:"Number of reports: 113\nInterval start: 2024-06-05 21:31:00 UTC\nInterval end: 2024-06-05 21:34:00 UTC\nInterval length: 180s\nAggregation result: [14, 10, 10, 13, 13, 8, 16, 13, 9, 7, 0]\ncollection: Collection { partial_batch_selector: PartialBatchSelector { batch_identifier: BatchId(wPLBlC6iHWp_YBBAYP_ig5nal0FOz1QlLSaC42U7sm0) }, report_count: 113, interval: (2024-06-05T21:31:00Z, TimeDelta { secs: 180, nanos: 0 }), aggregate_result: [14, 10, 10, 13, 13, 8, 16, 13, 9, 7, 0] }\n"})}),"\n",(0,a.jsx)(n.p,{children:'If you get an error like "The batch implied by the query is invalid", then the\naggregators are still working on processing your uploaded reports. Given them a\nfew more minutes.'}),"\n",(0,a.jsx)(n.p,{children:"If you get fewer reports in the collection than you uploaded, that's because you\nsent the collection request too soon and not all the reports were prepared yet.\nThose reports will be available in a later collection, after enough additional\nreports are uploaded to meet the minimum batch size."}),"\n",(0,a.jsx)(n.h2,{id:"next-steps",children:"Next Steps"}),"\n",(0,a.jsxs)(n.p,{children:["Congratulations! You've just used secure multi-party computation to do a\nprivacy-preserving aggregation over secret shares of measurements. Now you can\ntry experimenting with different tasks. Try creating different histograms with\ndifferent numbers of buckets, or see if you can use ",(0,a.jsx)(n.code,{children:"Prio3SumVec"})," to compute\nsums over bit vectors."]})]})}function h(e={}){const{wrapper:n}={...(0,i.a)(),...e.components};return n?(0,a.jsx)(n,{...e,children:(0,a.jsx)(d,{...e})}):d(e)}},1151:(e,n,t)=>{t.d(n,{Z:()=>l,a:()=>o});var a=t(7294);const i={},r=a.createContext(i);function o(e){const n=a.useContext(r);return a.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function l(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:o(e.components),a.createElement(r.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/main.1a97efdb.js b/assets/js/main.1a97efdb.js
deleted file mode 100644
index cd7bba2..0000000
--- a/assets/js/main.1a97efdb.js
+++ /dev/null
@@ -1,2 +0,0 @@
-/*! For license information please see main.1a97efdb.js.LICENSE.txt */
-(self.webpackChunkpublic_docs=self.webpackChunkpublic_docs||[]).push([[179],{723:(e,t,n)=>{"use strict";n.d(t,{Z:()=>p});n(7294);var r=n(8356),o=n.n(r),a=n(6887);const i={"08268e2c":[()=>n.e(887).then(n.bind(n,3589)),"@site/docs/references/janus-errors.md",3589],"0e384e19":[()=>n.e(671).then(n.bind(n,6003)),"@site/docs/intro.md",6003],"151e8182":[()=>n.e(687).then(n.bind(n,7653)),"@site/docs/product-documentation/operational-metrics.md",7653],17896441:[()=>Promise.all([n.e(532),n.e(918)]).then(n.bind(n,9762)),"@theme/DocItem",9762],"22dd74f7":[()=>n.e(980).then(n.t.bind(n,5904,19)),"@generated/docusaurus-plugin-content-docs/default/p/index-466.json",5904],"5e95c892":[()=>n.e(661).then(n.bind(n,1892)),"@theme/DocsRoot",1892],76183543:[()=>n.e(727).then(n.bind(n,4788)),"@site/docs/how-it-works.md",4788],"846bd6ee":[()=>Promise.all([n.e(532),n.e(433)]).then(n.bind(n,5062)),"@site/docs/references/references.md",5062],"96f8aff4":[()=>Promise.all([n.e(532),n.e(262)]).then(n.bind(n,6757)),"@site/docs/product-documentation/product-documentation.mdx",6757],"9f6ba728":[()=>n.e(826).then(n.bind(n,2857)),"@site/docs/product-documentation/categorical-histogram-dap-04.md",2857],a7bd4aaa:[()=>n.e(518).then(n.bind(n,8564)),"@theme/DocVersionRoot",8564],a94703ab:[()=>Promise.all([n.e(532),n.e(368)]).then(n.bind(n,2674)),"@theme/DocRoot",2674],aba21aa0:[()=>n.e(629).then(n.t.bind(n,1765,19)),"@generated/docusaurus-plugin-content-docs/default/__plugin.json",1765],d62d0f31:[()=>n.e(474).then(n.bind(n,2352)),"@site/docs/command-line-tutorial.md",2352],eae929fd:[()=>n.e(162).then(n.bind(n,139)),"@site/docs/references/glossary.md",139]};var l=n(5893);function s(e){let{error:t,retry:n,pastDelay:r}=e;return t?(0,l.jsxs)("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"},children:[(0,l.jsx)("p",{children:String(t)}),(0,l.jsx)("div",{children:(0,l.jsx)("button",{type:"button",onClick:n,children:"Retry"})})]}):r?(0,l.jsx)("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"},children:(0,l.jsx)("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb",children:(0,l.jsxs)("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2",children:[(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsxs)("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0",children:[(0,l.jsx)("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),(0,l.jsx)("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})]}),(0,l.jsx)("circle",{cx:"22",cy:"22",r:"8",children:(0,l.jsx)("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"})})]})})}):null}var u=n(9670),c=n(226);function d(e,t){if("*"===e)return o()({loading:s,loader:()=>n.e(772).then(n.bind(n,1772)),modules:["@theme/NotFound"],webpack:()=>[1772],render(e,t){const n=e.default;return(0,l.jsx)(c.z,{value:{plugin:{name:"native",id:"default"}},children:(0,l.jsx)(n,{...t})})}});const r=a[`${e}-${t}`],d={},p=[],f=[],m=(0,u.Z)(r);return Object.entries(m).forEach((e=>{let[t,n]=e;const r=i[n];r&&(d[t]=r[0],p.push(r[1]),f.push(r[2]))})),o().Map({loading:s,loader:d,modules:p,webpack:()=>f,render(t,n){const o=JSON.parse(JSON.stringify(r));Object.entries(t).forEach((t=>{let[n,r]=t;const a=r.default;if(!a)throw new Error(`The page component at ${e} doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.`);"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((e=>"default"!==e)).forEach((e=>{a[e]=r[e]}));let i=o;const l=n.split(".");l.slice(0,-1).forEach((e=>{i=i[e]})),i[l[l.length-1]]=a}));const a=o.__comp;delete o.__comp;const i=o.__context;delete o.__context;const s=o.__props;return delete o.__props,(0,l.jsx)(c.z,{value:i,children:(0,l.jsx)(a,{...o,...s,...n})})}})}const p=[{path:"/",component:d("/","152"),routes:[{path:"/",component:d("/","8eb"),routes:[{path:"/",component:d("/","e07"),routes:[{path:"/command-line-tutorial",component:d("/command-line-tutorial","273"),exact:!0,sidebar:"docSidebar"},{path:"/glossary",component:d("/glossary","7ac"),exact:!0,sidebar:"docSidebar"},{path:"/how-it-works",component:d("/how-it-works","7bf"),exact:!0,sidebar:"docSidebar"},{path:"/product-documentation/",component:d("/product-documentation/","aed"),exact:!0,sidebar:"docSidebar"},{path:"/product-documentation/categorical-histogram-dap-04",component:d("/product-documentation/categorical-histogram-dap-04","e68"),exact:!0,sidebar:"docSidebar"},{path:"/product-documentation/operational-metrics",component:d("/product-documentation/operational-metrics","2b1"),exact:!0,sidebar:"docSidebar"},{path:"/references/",component:d("/references/","2de"),exact:!0,sidebar:"docSidebar"},{path:"/references/janus-errors",component:d("/references/janus-errors","2b0"),exact:!0,sidebar:"docSidebar"},{path:"/",component:d("/","e5d"),exact:!0,sidebar:"docSidebar"}]}]}]},{path:"*",component:d("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>i});var r=n(7294),o=n(5893);const a=r.createContext(!1);function i(e){let{children:t}=e;const[n,i]=(0,r.useState)(!1);return(0,r.useEffect)((()=>{i(!0)}),[]),(0,o.jsx)(a.Provider,{value:n,children:t})}},7221:(e,t,n)=>{"use strict";var r=n(7294),o=n(745),a=n(405),i=n(3727),l=n(6809),s=n(412);const u=[n(2497),n(3310),n(8320),n(2295)];var c=n(723),d=n(6550),p=n(8790),f=n(5893);function m(e){let{children:t}=e;return(0,f.jsx)(f.Fragment,{children:t})}var g=n(5742),h=n(2263),y=n(4996),b=n(6668),v=n(1944),w=n(4711),k=n(9727),x=n(3320),S=n(8780),E=n(197);function C(){const{i18n:{currentLocale:e,defaultLocale:t,localeConfigs:n}}=(0,h.Z)(),r=(0,w.l)(),o=n[e].htmlLang,a=e=>e.replace("-","_");return(0,f.jsxs)(g.Z,{children:[Object.entries(n).map((e=>{let[t,{htmlLang:n}]=e;return(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:n},t)})),(0,f.jsx)("link",{rel:"alternate",href:r.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}),(0,f.jsx)("meta",{property:"og:locale",content:a(o)}),Object.values(n).filter((e=>o!==e.htmlLang)).map((e=>(0,f.jsx)("meta",{property:"og:locale:alternate",content:a(e.htmlLang)},`meta-og-${e.htmlLang}`)))]})}function _(e){let{permalink:t}=e;const{siteConfig:{url:n}}=(0,h.Z)(),r=function(){const{siteConfig:{url:e,baseUrl:t,trailingSlash:n}}=(0,h.Z)(),{pathname:r}=(0,d.TH)();return e+(0,S.applyTrailingSlash)((0,y.ZP)(r),{trailingSlash:n,baseUrl:t})}(),o=t?`${n}${t}`:r;return(0,f.jsxs)(g.Z,{children:[(0,f.jsx)("meta",{property:"og:url",content:o}),(0,f.jsx)("link",{rel:"canonical",href:o})]})}function T(){const{i18n:{currentLocale:e}}=(0,h.Z)(),{metadata:t,image:n}=(0,b.L)();return(0,f.jsxs)(f.Fragment,{children:[(0,f.jsxs)(g.Z,{children:[(0,f.jsx)("meta",{name:"twitter:card",content:"summary_large_image"}),(0,f.jsx)("body",{className:k.h})]}),n&&(0,f.jsx)(v.d,{image:n}),(0,f.jsx)(_,{}),(0,f.jsx)(C,{}),(0,f.jsx)(E.Z,{tag:x.HX,locale:e}),(0,f.jsx)(g.Z,{children:t.map(((e,t)=>(0,f.jsx)("meta",{...e},t)))})]})}const j=new Map;var L=n(8934),A=n(8940),N=n(469);function P(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;rYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),o=n(9642),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),a.add(e)}))}i.silent=!1,e.exports=i},6854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;sYour Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n.comment can become .namespace--comment) or replace them with your defined ones (like .editor__comment). You can even add new classes.",owner:"dvkndn",noCSS:!0},"file-highlight":{title:"File Highlight",description:"Fetch external files and highlight them with Prism. Used on the Prism website itself.",noCSS:!0},"show-language":{title:"Show Language",description:"Display the highlighted language in code blocks (inline code does not show the label).",owner:"nauzilus",noCSS:!0,require:"toolbar"},"jsonp-highlight":{title:"JSONP Highlight",description:"Fetch content with JSONP and highlight some interesting content (e.g. GitHub/Gists or Bitbucket API).",noCSS:!0,owner:"nauzilus"},"highlight-keywords":{title:"Highlight Keywords",description:"Adds special CSS classes for each keyword for fine-grained highlighting.",owner:"vkbansal",noCSS:!0},"remove-initial-line-feed":{title:"Remove initial line feed",description:"Removes the initial line feed in code blocks.",owner:"Golmote",noCSS:!0},"inline-color":{title:"Inline color",description:"Adds a small inline preview for colors in style sheets.",require:"css-extras",owner:"RunDevelopment"},previewers:{title:"Previewers",description:"Previewers for angles, colors, gradients, easing and time.",require:"css-extras",owner:"Golmote"},autoloader:{title:"Autoloader",description:"Automatically loads the needed languages to highlight the code blocks.",owner:"Golmote",noCSS:!0},"keep-markup":{title:"Keep Markup",description:"Prevents custom markup from being dropped out during highlighting.",owner:"Golmote",optional:"normalize-whitespace",noCSS:!0},"command-line":{title:"Command Line",description:"Display a command line with a prompt and, optionally, the output/response from the commands.",owner:"chriswells0"},"unescaped-markup":{title:"Unescaped Markup",description:"Write markup without having to escape anything."},"normalize-whitespace":{title:"Normalize Whitespace",description:"Supports multiple operations to normalize whitespace in code blocks.",owner:"zeitgeist87",optional:"unescaped-markup",noCSS:!0},"data-uri-highlight":{title:"Data-URI Highlight",description:"Highlights data-URI contents.",owner:"Golmote",noCSS:!0},toolbar:{title:"Toolbar",description:"Attach a toolbar for plugins to easily register buttons on the top of a code block.",owner:"mAAdhaTTah"},"copy-to-clipboard":{title:"Copy to Clipboard Button",description:"Add a button that copies the code block to the clipboard when clicked.",owner:"mAAdhaTTah",require:"toolbar",noCSS:!0},"download-button":{title:"Download Button",description:"A button in the toolbar of a code block adding a convenient way to download a code file.",owner:"Golmote",require:"toolbar",noCSS:!0},"match-braces":{title:"Match braces",description:"Highlights matching braces.",owner:"RunDevelopment"},"diff-highlight":{title:"Diff Highlight",description:"Highlights the code inside diff blocks.",owner:"RunDevelopment",require:"diff"},"filter-highlight-all":{title:"Filter highlightAll",description:"Filters the elements the highlightAll and highlightAllUnder methods actually highlight.",owner:"RunDevelopment",noCSS:!0},treeview:{title:"Treeview",description:"A language with special styles to highlight file system tree structures.",owner:"Golmote"}}})},2885:(e,t,n)=>{const r=n(9901),o=n(9642),a=new Set;function i(e){void 0===e?e=Object.keys(r.languages).filter((e=>"meta"!=e)):Array.isArray(e)||(e=[e]);const t=[...a,...Object.keys(Prism.languages)];o(r,e,t).load((e=>{if(!(e in r.languages))return void(i.silent||console.warn("Language does not exist: "+e));const t="./prism-"+e;delete n.c[n(6500).resolve(t)],delete Prism.languages[e],n(6500)(t),a.add(e)}))}i.silent=!1,e.exports=i},6854:()=>{!function(e){function t(e,t){return"___"+e.toUpperCase()+t+"___"}Object.defineProperties(e.languages["markup-templating"]={},{buildPlaceholders:{value:function(n,r,o,a){if(n.language===r){var i=n.tokenStack=[];n.code=n.code.replace(o,(function(e){if("function"==typeof a&&!a(e))return e;for(var o,l=i.length;-1!==n.code.indexOf(o=t(r,l));)++l;return i[l]=e,o})),n.grammar=e.languages.markup}}},tokenizePlaceholders:{value:function(n,r){if(n.language===r&&n.tokenStack){n.grammar=e.languages[r];var o=0,a=Object.keys(n.tokenStack);!function i(l){for(var s=0;s