\n';
44 | }
45 | };
46 |
47 | /**
48 | * Wires up a generic markdownItContainer render function for a specified admonition.
49 | * @param {string} admonitionName The "tag" of the admonition to be rendered
50 | * @returns render function for the admonition type that works with markdownItContainer
51 | */
52 | function composeGenericAdmonitionRenderFunc(admonitionName) {
53 | return function(tokens, idx) { return renderAdmonition(admonitionName, tokens, idx); }
54 | }
55 |
56 | /* End Admonition code */
57 |
58 | /* Start Details Block code */
59 |
60 | function composeDetailsBlockRenderFunc(blockName = "details") {
61 | return function(tokens, idx) { return renderDetailsBlock(blockName, tokens, idx); }
62 | }
63 |
64 | const renderDetailsBlock = (blockName, tokens, idx) => {
65 | if(tokens[idx].nesting === 1) {
66 | const summary = tokens[idx].info.trim().match(generateContainerTitleRegex(blockName));
67 | const attrDefaults = { id: slugify(summary[1]) };
68 | if (blockName) {
69 | attrDefaults['class'] = `details ${blockName}`;
70 | }
71 | const attrString = composeAttributeString(tokens[idx], attrDefaults);
72 |
73 | const summaryTag = summary ? `${ summary[1] }` : '';
74 | return `${summaryTag}` + '\n\n
';
75 | } else {
76 | return '\n
\n';
77 | }
78 | };
79 |
80 | const validateDetailsBlock = (params) => {
81 | const validationResults = params.trim().match(/^details\s+(.*)$/);
82 | return validationResults;
83 | }
84 |
85 | /* End Details Block code */
86 |
87 | // Set up the Markdown-it parser here.
88 |
89 | const mdLib = markdownIt();
90 |
91 | // Set up sane defaults; most of these are borrowed from 11ty's defaults.
92 | mdLib.set({
93 | html: true,
94 | linkify: true,
95 | typographer: true
96 | });
97 | mdLib.disable("code");
98 |
99 | //Configure markdown-it plugins
100 | mdLib.use(markdownItAttrs);
101 | mdLib.use(markdownItAnchor, {
102 | tabIndex: false,
103 | slugify: s => slugify(s),
104 | permalink: markdownItAnchor.permalink.headerLink(),
105 | });
106 | mdLib.use(markdownItContainer, "intro");
107 | mdLib.use(markdownItContainer, "orientation");
108 | mdLib.use(markdownItContainer, "storystep");
109 | mdLib.use(markdownItContainer, "h-author");
110 | mdLib.use(markdownItContainer, "topic-list");
111 | mdLib.use(markdownItContainer, "output-block");
112 |
113 | // Admonitions
114 | mdLib.use(markdownItContainer, "tip", { marker: "!", render: composeGenericAdmonitionRenderFunc("tip") });
115 | mdLib.use(markdownItContainer, "note", { marker: "!", render: composeGenericAdmonitionRenderFunc("note") });
116 | mdLib.use(markdownItContainer, "info", { marker: "!", render: composeGenericAdmonitionRenderFunc("info") });
117 | mdLib.use(markdownItContainer, "learn", { marker: "!", render: composeGenericAdmonitionRenderFunc("learn") });
118 |
119 | // Details block
120 | mdLib.use(markdownItContainer, "details", { marker: "!", render: composeDetailsBlockRenderFunc() });
121 | // Create a specialized synonym for details block with a class of "dig-deeper"
122 | mdLib.use(markdownItContainer, "dig-deeper", { marker: "!", render: composeDetailsBlockRenderFunc("dig-deeper") });
123 |
124 | export default mdLib;
--------------------------------------------------------------------------------
/11ty-extensions/nunjucks-exts.js:
--------------------------------------------------------------------------------
1 |
2 | export default function(eleventyConfig) {
3 |
4 | eleventyConfig.addNunjucksGlobal("callMacroByName", function(name) {
5 | if (!name) {
6 | return;
7 | }
8 |
9 | const otherArgs = [...arguments].slice(1);
10 | const member = this.ctx[name];
11 | if (typeof member === "function") {
12 | return member(...otherArgs);
13 | }
14 | });
15 |
16 | eleventyConfig.addNunjucksGlobal("ConsoleLog", function() {
17 | console.log(...arguments);
18 | });
19 |
20 | };
--------------------------------------------------------------------------------
/11ty-markdown-changes.md:
--------------------------------------------------------------------------------
1 |
2 | ## Titles go in Front Matter
3 | - H1s will be in higher level layouts. Do not include in md body.
4 | - Page title should go in Front Matter at top of MD file.
5 | Example:
6 | ```
7 | ---
8 | title: Create a New App
9 | ---
10 | ```
11 |
12 | ## Divs
13 | - No more `markdown=1`, instead leave a blank line after.
14 | - Core Concepts intro and orientation divs have had their `coreconcepts-` prefixes removed and can now be created as MD containers. `coreconcepts-storysequence` blocks have been replaced with individual `storystep` blocks around each step in a story sequence. Use:
15 | ```
16 | ::: intro
17 | words words
18 | :::
19 | ```
20 | If you need to nest containers add an additional `:` on each outer layer.
21 |
22 | ## Admonitions
23 | - Do NOT indent contents of Admonitions
24 | - Admonitions must be closed with `!!!`
25 | - You can add a title (Example: ```!!! note Run in `nix-shell https://holochain.love` ```), Otherwise it will use the name of the Admonition.
26 |
27 | ## Code Fences
28 | - Include language (i.e.: `bash`) always.
29 | - If you want to surpress the copy button wrap the code block in a `::: output-block` container
30 | - Code blocks meant to be copied and pasted into a terminal should use `shell` rather than `bash`; they'll automatically get styled with a non-copyable `$` at the beginning of the first line.
31 |
32 | ## Open in new window
33 | - add `{target=_blank}` after link markdown parens
34 |
35 | ## Button for link
36 | - add `{.btn-purple}` after link markdown parens
37 |
38 | ## Center an Image
39 | ```
40 | 
41 | {.center}
42 | ```
43 | Note: The new line after the image is required to put the class in the enclosing `
`
44 |
45 | ## Tweak the size of an image
46 | Obviously it would be optimal to actually resize the image. But you can tweak the max-width with the classes
47 | `sz10p` (10%) through `sz200p` (200%)
48 | ```
49 | {.sz50p}
50 | ```
51 |
52 | ## Table of contents
53 | An on-page table of contents is generated automatically for every page from all `h2` to `h6` elements that have `id` attributes. If you don't want this to happen, put `tocData: false` in your page's front matter. You can also selectively prevent a header from being included in the table of contents by either suppressing its ID attribute or adding a `data-no-toc` attribute:
54 |
55 | ```markdown
56 | ## I am a header that shouldn't appear in the TOC {data-no-toc}
57 | ```
58 |
59 | If you want to craft a custom table of contents, instead assign a nested array to `tocData` that looks like this:
60 |
61 | ```yaml
62 | tocData:
63 | - text: First section header
64 | href: first-section-header
65 | children:
66 | - text: Subsection header 1
67 | href: subsection-header-1
68 | - text: Subsection header 2
69 | href: subsection-header-2
70 | - text: Second section header
71 | href: second-section-header
72 | - text: Conclusion
73 | href: conclusion
74 | ```
75 |
76 | There are two things to note about the above:
77 |
78 | * IDs are automatically generated for all headers; they'll be the slug of the header text. You can override a header's ID with a `{#custom-id}` attribute.
79 | * Although the `href` property suggests it should be a resolvable URL, don't put the `#` at the beginning of its value.
80 |
81 | ## Items to add to README
82 | - using callMacroByName
83 |
84 |
85 |
86 |
--------------------------------------------------------------------------------
/CNAME:
--------------------------------------------------------------------------------
1 | developer.holochain.org
--------------------------------------------------------------------------------
/code_test_4/web-happ.yaml:
--------------------------------------------------------------------------------
1 | manifest_version: '1'
2 | name: blup
3 | ui:
4 | bundled: ./path/to/my/ui.zip
5 | happ_manifest:
6 | bundled: ./path/to/my/happ-bundle.happ
7 |
--------------------------------------------------------------------------------
/cspell.json:
--------------------------------------------------------------------------------
1 | {
2 | "import": ["@cspell/dict-lorem-ipsum/cspell-ext.json", "@cspell/dict-rust/cspell-ext.json"],
3 | "dictionaries": ["holochain", "words-that-should-exist", "custom", "template", "html", "css", "softwareTerms", "lorem-ipsum", "rust"],
4 | "dictionaryDefinitions": [
5 | {
6 | "name": "holochain",
7 | "path": "./.cspell/holochain-words.txt"
8 | },
9 | {
10 | "name": "words-that-should-exist",
11 | "path": "./.cspell/words-that-should-exist.txt"
12 | },
13 | {
14 | "name": "custom",
15 | "path": "./.cspell/custom-words.txt"
16 | },
17 | {
18 | "name": "template",
19 | "path": "./.cspell/template-words.txt"
20 | }
21 | ]
22 | }
--------------------------------------------------------------------------------
/eleventy.config.js:
--------------------------------------------------------------------------------
1 | import { EleventyRenderPlugin } from "@11ty/eleventy";
2 | import externalLinks from "@aloskutov/eleventy-plugin-external-links";
3 |
4 | import registerExtensions from "./11ty-extensions/index.js";
5 |
6 | export default function(eleventyConfig) {
7 |
8 | eleventyConfig.addPassthroughCopy({"./src/assets/": "assets"});
9 | eleventyConfig.addPassthroughCopy({"./node_modules/font-awesome/css": "assets/font-awesome/css"});
10 | eleventyConfig.addPassthroughCopy({"./node_modules/font-awesome/fonts": "assets/font-awesome/fonts"});
11 | eleventyConfig.addPassthroughCopy({"./node_modules/highlight.js/styles/atom-one-light.min.css": "styles/highlight.js-atom-one-light.min.css"});
12 |
13 | eleventyConfig.addPassthroughCopy({"./client-side-compiled/**/*": "scripts"});
14 | eleventyConfig.addPassthroughCopy({"./styles-compiled/**/*": "styles"});
15 | eleventyConfig.addPassthroughCopy({"./src/copy-to-root/*": "."});
16 |
17 | /* If you have any libs being pulled from node_modules you might do it like below */
18 | eleventyConfig.addPassthroughCopy({"./node_modules/lunr/lunr.min.js": "scripts/libs/lunr.min.js"});
19 |
20 | eleventyConfig.setUseGitIgnore(false);
21 | eleventyConfig.setDataDeepMerge(false);
22 |
23 | eleventyConfig.addPlugin(EleventyRenderPlugin);
24 | eleventyConfig.addPlugin(externalLinks, {overwrite: false});
25 |
26 | eleventyConfig.setServerOptions({
27 | showAllHosts: true
28 | });
29 |
30 | eleventyConfig.setWatchThrottleWaitTime(100);
31 |
32 | registerExtensions(eleventyConfig);
33 |
34 | return {
35 | dir: {
36 | input: "src/pages",
37 | }
38 | }
39 | };
--------------------------------------------------------------------------------
/netlify.toml:
--------------------------------------------------------------------------------
1 | # Enable broken link checking in Netlify CI
2 | # Disabling for now so I can configure per environment.
3 | # [[plugins]]
4 | # package = "netlify-plugin-checklinks"
5 | # [plugins.inputs]
6 | # entryPoints = [
7 | # "*.html",
8 | # ]
9 |
10 | # recursive = true
11 | # pretty = true
12 | # checkExternal = false
13 |
14 | [[headers]]
15 | for = "/*"
16 | [headers.values]
17 | Access-Control-Allow-Origin = "*"
18 |
19 | # These first rules are a bit fiddly -- we explicitly redirect URLs that we know should
20 | # point to the Redux docs, rather than redirecting to `/`, then to `/redirect-to-redux-site.html`,
21 | # which ends up breaking things on the Redux site side.
22 | [[redirects]]
23 | from = "/docs/guide/*"
24 | to = "/redirect-to-redux-site.html#!docs/guide/:splat"
25 | # We may use this path for a new guidebook.
26 | status = 302
27 |
28 | [[redirects]]
29 | from = "/docs/tutorials/*"
30 | to = "/redirect-to-redux-site.html#!docs/tutorials/:splat"
31 | # Holding open the possibility of tutorials too.
32 | status = 302
33 |
34 | [[redirects]]
35 | from = "/docs/create-new-app/"
36 | to = "/redirect-to-redux-site.html#!docs/create-new-app/"
37 | status = 302
38 |
39 | [[redirects]]
40 | from = "/resources/happ-bundle/"
41 | to = "/redirect-to-redux-site.html#!docs/resources/happ-bundle/"
42 | # There will eventually be a new hApp bundle format that will get documented,
43 | # and I intend to put it under `/resources`.
44 | status = 302
45 |
46 | # Some of the core concepts' titles and URLs have changed,
47 | # but fortunately they map to new core concepts (sometimes roughly, sometimes exactly)
48 | # so let's redirect them.
49 | [[redirects]]
50 | from = "/docs/concepts/3_private_data/"
51 | to = "/concepts/3_source_chain/"
52 | status = 301
53 |
54 | [[redirects]]
55 | from = "/docs/concepts/4_public_data_on_the_dht/"
56 | to = "/concepts/4_dht/"
57 | status = 301
58 |
59 | [[redirects]]
60 | from = "/docs/concepts/5_linking_data_together/"
61 | to = "/concepts/5_links_anchors/"
62 | status = 301
63 |
64 | [[redirects]]
65 | from = "/docs/concepts/6_modifying_and_deleting_data/"
66 | to = "/concepts/6_crud_actions/"
67 | status = 301
68 |
69 | [[redirects]]
70 | from = "/docs/concepts/8_node_to_node_messaging/"
71 | to = "/concepts/8_calls_capabilities/"
72 | status = 301
73 |
74 | [[redirects]]
75 | from = "/references/*"
76 | to = "/resources/:splat"
77 | status = 301
78 |
79 | # Once upon a time, we had a landing page and all the actual docs were in /docs.
80 | [[redirects]]
81 | from = "/docs/*"
82 | to = "/:splat"
83 | status = 301
84 |
85 | # Super old install URL; used to be incorrectly linked from the blog's CTAs.
86 | [[redirects]]
87 | from = "/start.html"
88 | to = "/quick-start/"
89 | status = 301
90 |
91 | # This is just for the nix guide, which is now called the advanced install guide.
92 | [[redirects]]
93 | from = "/docs/nix/"
94 | to = "/install-advanced/"
95 | status = 301
96 |
97 | # The rrDHT paper got finalised, so let's redirect to the final copy.
98 | [[redirects]]
99 | from = "/assets/files/RRDHT-draft-Nov-2019.pdf"
100 | to = "/assets/files/RRDHT-whitepaper-final.pdf"
101 | status = 301
102 |
103 | # The quick start guide used to live at /install/
104 | [[redirects]]
105 | from = "/install/"
106 | to = "/get-started/"
107 | status = 301
108 |
109 | # Glossary has been moved to the resources path.
110 | [[redirects]]
111 | from = "/glossary/"
112 | to = "/resources/glossary/"
113 | status = 301
114 |
115 | # The front page for the core concepts has been removed.
116 | [[redirects]]
117 | from = "/concepts/"
118 | to = "/concepts/1_the_basics/"
119 | # Keeping this as a 302 in case we decide we want a front page again.
120 | status = 302
121 |
122 | # Shuffled some things around August 2023
123 | [[redirects]]
124 | from = "/get-building/*"
125 | to = "/get-started/:splat"
126 | status = 301
127 |
128 | [[redirects]]
129 | from = "/quick-start/"
130 | to = "/get-started/"
131 | status = 301
132 |
133 | # The first upgrade guide lived under getting started. It has been moved to its own area.
134 | [[redirects]]
135 | from = "/get-started/upgrade-holochain/"
136 | to = "/resources/upgrade/"
137 | status = 301
138 |
139 | # Every time there's a new breaking release that achieves 'recommended' status,
140 | # update this temporary redirect. /resources/upgrade/latest/ isn't in the site nav,
141 | # but it is a handy URL we can hand out without needing to look up what the proper URL is.
142 | # TODO(upgrade): change following version number
143 | [[redirects]]
144 | from = "/resources/upgrade/latest/"
145 | to = "/resources/upgrade/upgrade-holochain-0.5/"
146 | status = 302
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "holochain-docs-pages",
3 | "version": "1.0.0",
4 | "description": "11ty project for generating the Holochain documentation",
5 | "main": "index.cjs",
6 | "type": "module",
7 | "engines": {
8 | "node": ">=20"
9 | },
10 | "directories": {
11 | "doc": "docs"
12 | },
13 | "scripts": {
14 | "build:search-index": "npx pagefind --site _site --glob \"**/*.html\"",
15 | "build:web": "ELEVENTY_ENV=production npx @11ty/eleventy",
16 | "serve:web": "ELEVENTY_ENV=development npx @11ty/eleventy --serve --incremental",
17 | "serve:web-prod": "ELEVENTY_ENV=production BROWERSYNC=off npx @11ty/eleventy --serve",
18 | "debug:web": "DEBUG=Eleventy* ELEVENTY_ENV=development npx @11ty/eleventy --serve",
19 | "build:sass": "npx sass src/scss:styles-compiled",
20 | "watch:sass": "npx sass --watch src/scss:styles-compiled",
21 | "post:css": "npx postcss styles-compiled/site.css > styles-compiled/site.min.css",
22 | "min:js": "npx uglify-js _site/scripts/main.bundled.js --output _site/scripts/main.min.js",
23 | "bundle:js": "rollup -c rollup.config.js",
24 | "watch:js": "rollup -c rollup.config.js -w",
25 | "dev": "npm run build && npm-run-all -p serve:web watch:sass watch:js",
26 | "dev-no-js": "npm run build:sass && npm-run-all -p serve:web watch:sass",
27 | "build": "npm-run-all -s clean:site build:sass post:css clean:js bundle:js build:web build:search-index",
28 | "serve-as-prod": "npm-run-all -s clean:site build:sass post:css clean:js bundle:js serve:web-prod",
29 | "clean:js": "rm -rf client-side-compiled",
30 | "clean:css": "rm -rf styles-compiled",
31 | "clean:site": "rm -rf _site",
32 | "clean": "npm-run-all clean:site clean:js clean:css",
33 | "update-browserlist": "npx browserslist@latest --update-db"
34 | },
35 | "repository": {
36 | "type": "git",
37 | "url": "git+https://github.com/holochain/docs-pages.git"
38 | },
39 | "author": "",
40 | "license": "GPL-3.0-or-later",
41 | "bugs": {
42 | "url": "https://github.com/holochain/docs-pages/issues"
43 | },
44 | "homepage": "https://github.com/holochain/docs-pages#readme",
45 | "devDependencies": {
46 | "@11ty/eleventy": "^3.0.0-alpha.1",
47 | "@aloskutov/eleventy-plugin-external-links": "^2.1.1",
48 | "@rollup/plugin-terser": "^0.4.4",
49 | "@rollup/plugin-typescript": "^11.1.5",
50 | "@sindresorhus/slugify": "1.1.2",
51 | "@types/lunr": "^2.3.4",
52 | "@types/markdown-it": "^12.2.3",
53 | "autoprefixer": "^10.4.13",
54 | "cssnano": "^5.1.14",
55 | "fauxdom": "^1.1.1",
56 | "he": "^1.2.0",
57 | "highlight.js": "^11.9.0",
58 | "highlight.svelte": "^0.1.2",
59 | "highlightjs-code-diff": "^1.0.0",
60 | "html-minifier-terser": "^7.2.0",
61 | "html-to-text": "^8.2.1",
62 | "json5": "^2.2.3",
63 | "lunr": "^2.3.9",
64 | "markdown-it-anchor": "^8.6.6",
65 | "markdown-it-attrs": "^4.1.4",
66 | "markdown-it-container": "^3.0.0",
67 | "npm-run-all": "^4.1.5",
68 | "postcss": "^8.4.18",
69 | "postcss-cli": "^10.0.0",
70 | "posthtml": "^0.16.6",
71 | "posthtml-noopener": "^1.0.5",
72 | "rollup": "^3.2.5",
73 | "sass": "^1.56.0",
74 | "tslib": "^2.6.2",
75 | "typescript": "^4.8.4",
76 | "uglify-js": "^3.17.4"
77 | },
78 | "dependencies": {
79 | "pagefind": "^1.3.0"
80 | }
81 | }
82 |
--------------------------------------------------------------------------------
/rollup.config.js:
--------------------------------------------------------------------------------
1 | import typescript from '@rollup/plugin-typescript';
2 | import terser from '@rollup/plugin-terser';
3 |
4 | export default [
5 | {
6 | input: 'src/client-side/index.ts',
7 | output: {
8 | file: '_site/scripts/index.min.js',
9 | sourcemap: '_site/scripts/index.min.js.map',
10 | inlineDynamicImports: true,
11 | },
12 | plugins: [
13 | typescript(),
14 | terser(),
15 | ],
16 | },
17 | {
18 | input: 'src/client-side/page-search.ts',
19 | output: {
20 | file: '_site/scripts/page-search.min.js',
21 | sourcemap: '_site/scripts/page-search.min.js.map',
22 | },
23 | plugins: [
24 | typescript(),
25 | terser(),
26 | ],
27 | },
28 | ]
--------------------------------------------------------------------------------
/src/assets/files/RRDHT-whitepaper-final.pdf:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/files/RRDHT-whitepaper-final.pdf
--------------------------------------------------------------------------------
/src/assets/img/concepts/1.1-architecture-comparison.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/1.1-architecture-comparison.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.1-countersigning.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.1-countersigning.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.10-validate.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.10-validate.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.11-authorities-collect.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.11-authorities-collect.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.12-authorities-distribute.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.12-authorities-distribute.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.13-commit-and-publish.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.13-commit-and-publish.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.14-enzyme.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.14-enzyme.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.15-m-of-n-witnesses.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.15-m-of-n-witnesses.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.2-entry-exchange.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.2-entry-exchange.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.3-preflight.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.3-preflight.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.4-preflight-send.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.4-preflight-send.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.5-preflight-inspection.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.5-preflight-inspection.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.6-bob-lock.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.6-bob-lock.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.7-alice-lock.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.7-alice-lock.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.8-countersigning-session.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.8-countersigning-session.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/10.9-trial-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/10.9-trial-commit.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.1-mutual-execution.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.1-mutual-execution.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.10-whole-stack.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.10-whole-stack.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.2-data-integrity-membrane.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.2-data-integrity-membrane.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.3-process-membrane.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.3-process-membrane.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.4-client.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.4-client.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.5-conductor.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.5-conductor.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.6-happ.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.6-happ.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.7-cells-in-slots.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.7-cells-in-slots.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.8-dna-in-cell.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.8-dna-in-cell.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/2.9-zomes-in-dna.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/2.9-zomes-in-dna.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.1-key-generation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.1-key-generation.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.2-source-chain-as-journal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.2-source-chain-as-journal.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.3-genesis-records-1-and-2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.3-genesis-records-1-and-2.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.4-genesis-records-3-and-4.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.4-genesis-records-3-and-4.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.5-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.5-commit.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.6-action.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.6-action.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/3.7-prev-action.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/3.7-prev-action.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.1-network.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.1-network.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.10-gossip-resilience.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.10-gossip-resilience.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.11-retrieval.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.11-retrieval.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.12-healthy-network.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.12-healthy-network.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.13-partition.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.13-partition.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.14-resilience-building.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.14-resilience-building.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.15-partition-healing.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.15-partition-healing.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.2-public-entry-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.2-public-entry-commit.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.3-private-entry-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.3-private-entry-commit.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.4-address-space-and-neighborhoods.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.4-address-space-and-neighborhoods.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.5-alice-neighborhood.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.5-alice-neighborhood.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.7-alice-publish-address-calculation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.7-alice-publish-address-calculation.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.8-authority-resolution.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.8-authority-resolution.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/4.9-gossip-publish.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/4.9-gossip-publish.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.1-links.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.1-links.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.2-alice.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.2-alice.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.3-alice-username.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.3-alice-username.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.4-usernames-anchor.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.4-usernames-anchor.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.5-alice-album.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.5-alice-album.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.6-album-tracks.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.6-album-tracks.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.7-album-genres.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.7-album-genres.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.8-genres-anchor.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.8-genres-anchor.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/5.9-graph-database.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/5.9-graph-database.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/6.1-crud.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/6.1-crud.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.1-validation.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.1-validation.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.10-gossip-to-authorities.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.10-gossip-to-authorities.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.11-authorities-validate.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.11-authorities-validate.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.12-hold.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.12-hold.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.13-respond-validation-receipts.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.13-respond-validation-receipts.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.14-gossip-to-authorities.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.14-gossip-to-authorities.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.15-validate.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.15-validate.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.16-warrant.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.16-warrant.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.17-gossip-warrant.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.17-gossip-warrant.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.18-ejection.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.18-ejection.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.2-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.2-commit.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.3-validate.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.3-validate.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.4-validation-success.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.4-validation-success.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.5-persist-and-publish.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.5-persist-and-publish.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.6-commit.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.6-commit.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.7-validate.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.7-validate.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.8-validation-failure.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.8-validation-failure.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/7.9-return-error.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/7.9-return-error.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.1-calls.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.1-calls.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.2-client-call.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.2-client-call.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.3-inter-zome-call.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.3-inter-zome-call.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.4-bridge-call.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.4-bridge-call.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.5-remote-call.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.5-remote-call.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.6-unrestricted-capability.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.6-unrestricted-capability.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.7-transferrable-capability.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.7-transferrable-capability.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.8-assigned-capability.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.8-assigned-capability.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/8.9-author-capability.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/8.9-author-capability.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/9.1-signals.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/9.1-signals.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/9.2-client-signal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/9.2-client-signal.png
--------------------------------------------------------------------------------
/src/assets/img/concepts/9.3-remote-signal.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/concepts/9.3-remote-signal.png
--------------------------------------------------------------------------------
/src/assets/img/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/favicon.ico
--------------------------------------------------------------------------------
/src/assets/img/get-started/1-running-app-first-look.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/1-running-app-first-look.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/10-comment-components.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/10-comment-components.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/2-look-for-hellos.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/2-look-for-hellos.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/3-two-uis-and-playground.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/3-two-uis-and-playground.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/4-no-posts-found.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/4-no-posts-found.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/5-create-post-component.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/5-create-post-component.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/6-playground-first-post.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/6-playground-first-post.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/7-edit-post.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/7-edit-post.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/8-playground-after-edits.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/8-playground-after-edits.png
--------------------------------------------------------------------------------
/src/assets/img/get-started/9-playground-after-delete.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/get-started/9-playground-after-delete.png
--------------------------------------------------------------------------------
/src/assets/img/google-chrome.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/google-chrome.png
--------------------------------------------------------------------------------
/src/assets/img/google-chrome.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/google-chrome.webp
--------------------------------------------------------------------------------
/src/assets/img/holochain-gym.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-gym.jpg
--------------------------------------------------------------------------------
/src/assets/img/holochain-logo-black-1300.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-logo-black-1300.png
--------------------------------------------------------------------------------
/src/assets/img/holochain-logo-black-1300.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-logo-black-1300.webp
--------------------------------------------------------------------------------
/src/assets/img/holochain-logo-black.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-logo-black.png
--------------------------------------------------------------------------------
/src/assets/img/holochain-logo-black.webp:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-logo-black.webp
--------------------------------------------------------------------------------
/src/assets/img/holochain-logo-small.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-logo-small.png
--------------------------------------------------------------------------------
/src/assets/img/holochain-logo-white.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/holochain-logo-white.png
--------------------------------------------------------------------------------
/src/assets/img/icon-apple.svg:
--------------------------------------------------------------------------------
1 |
2 |
56 |
--------------------------------------------------------------------------------
/src/assets/img/icon-windows.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
18 |
19 |
--------------------------------------------------------------------------------
/src/assets/img/logo_light-2x.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/logo_light-2x.png
--------------------------------------------------------------------------------
/src/assets/img/playground-simulator.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/img/playground-simulator.jpg
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormBold/font.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormBold/font.woff
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormBold/font.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormBold/font.woff2
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormBoldItalic/font.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormBoldItalic/font.woff
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormBoldItalic/font.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormBoldItalic/font.woff2
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormExtraBold/font.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormExtraBold/font.woff
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormExtraBold/font.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormExtraBold/font.woff2
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormExtraBoldItalic/font.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormExtraBoldItalic/font.woff
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormExtraBoldItalic/font.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormExtraBoldItalic/font.woff2
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormItalic/font.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormItalic/font.woff
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormItalic/font.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormItalic/font.woff2
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormRegular/font.woff:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormRegular/font.woff
--------------------------------------------------------------------------------
/src/assets/webFonts/URWFormRegular/font.woff2:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/assets/webFonts/URWFormRegular/font.woff2
--------------------------------------------------------------------------------
/src/client-side/index.ts:
--------------------------------------------------------------------------------
1 | function copyCodeBlockClickHandler(e: Event) {
2 | const button = e.target as HTMLButtonElement;
3 | const codeEl = button.parentElement?.querySelector("code");
4 | if (!codeEl) { return; }
5 | navigator.clipboard.writeText(codeEl.innerText);
6 | }
7 |
8 | function addCopyButtonsToCodeSections() {
9 | const copyButtonTemplate = document.querySelector("#copy-button-template");
10 |
11 | const codeElms = document.querySelectorAll('pre > code');
12 | codeElms.forEach((codeEl: Element) => {
13 | // If there is a output-block class as an ancestor anywhere then don't add button
14 | if (codeEl.closest('.output-block')) {
15 | return;
16 | }
17 |
18 | const copyButtonFrag = copyButtonTemplate?.content.cloneNode(true);
19 |
20 | if (copyButtonFrag) {
21 | const preEl = codeEl.parentElement!;
22 | // insert the copyButtonFrag right before the code fence
23 | preEl.parentElement?.insertBefore(copyButtonFrag, preEl);
24 | const codeFenceWrapper = preEl.previousElementSibling!;
25 | // move the preEl into the new Node
26 | codeFenceWrapper.appendChild(preEl);
27 | const btnEl = codeFenceWrapper.querySelector("button[data-purpose]")!;
28 | btnEl.addEventListener("click", copyCodeBlockClickHandler);
29 | }
30 | });
31 | }
32 |
33 | addCopyButtonsToCodeSections();
34 |
35 | function setupDiffTabsClickHandler() {
36 | const diffContainers = document.querySelectorAll('.diff-container');
37 | diffContainers.forEach((container: Element) => {
38 | // Show diff by default.
39 | container.dataset.selected = 'diff';
40 | // Set up handlers to toggle between them.
41 | container.querySelector('.diff-show-diff')?.addEventListener('click', () => {
42 | container.dataset.selected = 'diff';
43 | });
44 | container.querySelector('.diff-show-final')?.addEventListener('click', () => {
45 | container.dataset.selected = 'final';
46 | });
47 | });
48 | }
49 |
50 | setupDiffTabsClickHandler();
51 |
52 | /**
53 | * Sets up the hamburger menu to show/hide the navigation
54 | */
55 | function setUpMenuToggle() {
56 | const buttons = document.querySelectorAll('.hamburger-activate');
57 |
58 | const openedClassName = "opened";
59 | buttons.forEach((btn) => {
60 | btn.addEventListener("click", () => {
61 | // Handle button change
62 | const isOpen = btn.classList.contains(openedClassName);
63 | btn.classList.toggle(openedClassName, !isOpen);
64 | btn.setAttribute("aria-expanded", isOpen.toString());
65 |
66 | // Handle the desired effect
67 | const sideBarEl = document.querySelector(".default-page-type .side-bar");
68 | sideBarEl?.classList.toggle("show", !isOpen);
69 |
70 | })
71 | })
72 | }
73 |
74 | setUpMenuToggle();
75 |
76 | /**
77 | * Sets up the Navigation open child buttons
78 | */
79 | function setupNavHandlers() {
80 | document.querySelectorAll("button[data-children-opener]").forEach((btn) => {
81 | btn.addEventListener("click", (e: Event) => {
82 | // Handle the open/close state
83 | const openedChildLevels = document.querySelectorAll("ul.nav-child-level.open");
84 | const clickedChildLevel = btn.parentElement?.querySelector("ul.nav-child-level");
85 | const currentStateOpen = clickedChildLevel?.classList.contains("open");
86 |
87 | openedChildLevels.forEach((ul) => ul.classList.remove("open"));
88 | clickedChildLevel?.classList.toggle("open", !currentStateOpen);
89 |
90 | // Handle the arrow direction
91 | const openedButtons = document.querySelectorAll("#main-nav ul.nav-top-level > li > button.up-arrow");
92 | openedButtons.forEach((btn) => btn.classList.remove("up-arrow"));
93 | btn.classList.toggle("up-arrow", !currentStateOpen);
94 | });
95 | });
96 | }
97 |
98 | setupNavHandlers();
99 |
100 | function openModalIFrame(url:string) {
101 | const template = document.querySelector('#modal-iframe-template');
102 |
103 | const frag = template?.content.cloneNode(true) as DocumentFragment;
104 | if (frag) {
105 | const div = frag.querySelector(".modal-iframe");
106 | const iframe = frag.querySelector(".modal-iframe iframe");
107 | const closeBtn = frag.querySelector(".modal-iframe .modal-iframe-close");
108 | if (div && iframe && closeBtn) {
109 | iframe.src = url;
110 | closeBtn.addEventListener("click", (e) => {
111 | document.querySelector(".modal-iframe")?.remove();
112 | });
113 | document.body.appendChild(frag);
114 | }
115 | }
116 | }
117 |
118 | document.querySelector(".take-the-survey")?.addEventListener("click", (e) => {
119 | e.preventDefault();
120 | openModalIFrame("https://form.typeform.com/to/AL0HFFy8");
121 | });
122 |
123 | const inPageToc = document.querySelector("#in-page-toc");
124 | if (inPageToc) {
125 | const tocLinks = inPageToc.querySelectorAll("li > a");
126 |
127 | const setCurrentSection = (sectionId: string) => {
128 | tocLinks.forEach((link) => {
129 | link.classList.toggle("current", link.getAttribute("href") === `#${sectionId}`);
130 | });
131 | }
132 |
133 | //set up intersection observer to highlight the current section
134 | const observerCallback = (entries: IntersectionObserverEntry[]) => {
135 | if (entries[0].isIntersecting) {
136 | setCurrentSection(entries[0].target.id);
137 | }
138 | };
139 |
140 | const observer = new IntersectionObserver(observerCallback, { rootMargin: "0px 0px 0px 0px" });
141 |
142 | tocLinks.forEach((link) => {
143 | const linkId = link.getAttribute("href")?.replace("#", "");
144 | const htag = document.querySelector(`[id="${linkId}"]`);
145 | if (htag) {
146 | observer.observe(htag);
147 | } else {
148 | console.warn("No htag found for link", link);
149 | }
150 | });
151 | }
152 |
153 | const openDetailsOnFragmentIdNavigation = () => {
154 | if (location.hash) {
155 | const targetedDetailsElement = document.querySelector("details" + location.hash);
156 | if (targetedDetailsElement) {
157 | targetedDetailsElement.setAttribute("open", "open");
158 | }
159 | }
160 | };
161 |
162 | // Open details elements when they have an ID that's navigated to.
163 | openDetailsOnFragmentIdNavigation();
164 | window.addEventListener("hashchange", openDetailsOnFragmentIdNavigation);
165 |
166 | // Load MyFonts counter for URW Form fonts asynchronously, not in JS.
167 | // This is a workaround for a weird error thrown by netlify-plugin-checklinks.
168 | fetch("//hello.myfonts.net/count/3e423c");
--------------------------------------------------------------------------------
/src/client-side/page-search.ts:
--------------------------------------------------------------------------------
1 | const debounce = (callback: (...params: any[]) => any, waitTime: number) => {
2 | let timeoutId: number | null = null;
3 |
4 | return (...args: any[]) => {
5 | if (timeoutId) {
6 | window.clearTimeout(timeoutId);
7 | }
8 |
9 | timeoutId = window.setTimeout(() => {
10 | callback.apply(null, args);
11 | }, waitTime);
12 | };
13 | }
14 |
15 | /** Query string parameter name holding the current search */
16 | const PagefindSearchKey = "pagefind-search";
17 |
18 | function setupPagefindUI() {
19 | const pagefindUIInstance = new PagefindUI({
20 | element: "#search",
21 | showImages: false,
22 | showSubResults: true
23 | });
24 |
25 | const searchInput = window.document.querySelector("#search .pagefind-ui__search-input")!;
26 | const pagefindSearchQString = (new URL(window.location.toString())).searchParams.get(PagefindSearchKey);
27 |
28 | if (pagefindSearchQString) {
29 | pagefindUIInstance.triggerSearch(pagefindSearchQString);
30 | }
31 |
32 | const debouncedInputHandler = debounce(() => updateSearchQueryString(searchInput?.value), 1000);
33 |
34 | // Clear the query string if it is empty
35 | searchInput?.addEventListener("input", (e: Event) => {
36 | if (searchInput.value === "") {
37 | updateSearchQueryString("");
38 | } else {
39 | debouncedInputHandler();
40 | }
41 | });
42 |
43 | // if the Enter key is clicked then append the search to the QueryString
44 | searchInput?.addEventListener("keydown", (e: KeyboardEvent) => {
45 | if (e.code === "Enter") {
46 | updateSearchQueryString(searchInput.value);
47 | }
48 | });
49 |
50 | // Clear the query string if clear button clicked
51 | window.document.querySelector("#search .pagefind-ui__search-clear")?.addEventListener("click", () => {
52 | updateSearchQueryString("");
53 | });
54 |
55 | searchInput?.focus();
56 |
57 | function updateSearchQueryString(term: string) {
58 | const url = new URL(window.location.toString());
59 | if (term.trim() == "") {
60 | url.searchParams.delete(PagefindSearchKey);
61 | } else if (url.searchParams.get(PagefindSearchKey) !== term) {
62 | url.searchParams.set(PagefindSearchKey, term);
63 | }
64 | history.pushState({}, "", url);
65 | }
66 | }
67 |
68 | setupPagefindUI();
--------------------------------------------------------------------------------
/src/client-side/types.d.ts:
--------------------------------------------------------------------------------
1 | declare class PagefindUIClass {
2 | constructor(opts: any);
3 | triggerSearch(term: string);
4 | }
5 |
6 | declare var PagefindUI = PagefindUIClass;
--------------------------------------------------------------------------------
/src/custom/icon-apple.svg:
--------------------------------------------------------------------------------
1 |
2 |
56 |
--------------------------------------------------------------------------------
/src/custom/icon-windows.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
18 |
19 |
--------------------------------------------------------------------------------
/src/custom/script.js:
--------------------------------------------------------------------------------
1 | if (document.location.pathname.indexOf("/concepts/") == 0) {
2 | document.body.className = "page-concepts";
3 | }
--------------------------------------------------------------------------------
/src/pages/404.njk:
--------------------------------------------------------------------------------
1 | ---
2 | title: Oops!
3 | permalink: 404.html
4 | layout: ""
5 | ---
6 |
7 |
8 |
9 |
10 |
11 | {% if site.environment == "production" %}
12 |
13 | {% else %}
14 |
15 | {% endif %}
16 | {{ title }}
17 |
44 |
45 |
46 |
{{ title }}
47 |
404 - Page not found
48 |
The page you are looking for might have been removed, had its name changed, or is temporarily unavailable.
24 | It looks like you are using Internet Explorer. While the basic content is available,
25 | this is no longer a supported browser by the manufacturer, and no attention is being given to having IE work well here.
26 |
27 |
28 |
29 |
30 | Firefox, Edge and Chrome are all excellent browsers to use instead.
31 | Click one of the icons below to download.
32 |
46 |
47 |
--------------------------------------------------------------------------------
/src/pages/build/application-structure.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Application Structure
3 | ---
4 |
5 | ::: topic-list
6 | ### In this section {data-no-toc}
7 |
8 | * Application Structure (this page)
9 | * [Zomes](/build/zomes/) --- integrity vs coordinator, how to structure and compile
10 | * [Lifecycle Events and Callbacks](/build/callbacks-and-lifecycle-hooks/) --- writing functions that respond to events in a hApp's lifecycle
11 | * [Zome Functions](/build/zome-functions/) --- writing your hApp's back-end API
12 | * [DNAs](/build/dnas/) --- what they're used for, how to specify and bundle
13 | * [hApps](/build/happs/) --- headless vs UI-based, how to bundle and distribute
14 | * [Cloning](/build/cloning/) --- working with clones of a DNA
15 | :::
16 |
17 | ::: intro
18 | There are a few basic units of composability and packaging you'll need to know about when you're structuring your hApp. Each has different purposes, and the way you break up your code makes a difference to how it works in terms of access, privacy, participant responsibilities, and code reuse.
19 | :::
20 |
21 | ## Zomes, DNAs, and hApps
22 |
23 | ### Zome
24 |
25 | The smallest unit in a hApp is called a **zome** (a play on DNA chromosomes). It's the actual binary code that runs in Holochain's [WebAssembly](https://webassembly.org/) sandbox.
26 |
27 | !!! info Why WebAssembly?
28 |
29 | We chose WebAssembly because:
30 |
31 | * A [number of languages](https://github.com/appcypher/awesome-wasm-langs) can already be compiled to WebAssembly, which we hope will mean Holochain can support many languages on the back end in the future (currently we only supply a back-end SDK for Rust.)
32 | * It's small and fast --- it can get compiled to machine code for near-native speed.
33 | * Holochain is written in Rust, and Rust has an excellent WebAssembly engine called [Wasmer](https://wasmer.io/) that works on all the major operating systems.
34 | * It provides a secure sandbox to run untrusted code within.
35 |
36 | !!!
37 |
38 | A zome has access to Holochain via the **host API** and also exposes functions of its own. Some of these functions are **callbacks** and some of them you invent yourself to create your back end's API.
39 |
40 | There are two kinds of zome:
41 |
42 | * An **integrity zome** defines a set of data types --- your application's schema --- and validation rules for operations that create, update, or delete data of those types; in other words, your data model.
43 | * A **coordinator zome** defines a set of functions for interacting with data, peers, and other coordinator zomes.
44 |
45 | Zomes are usually created as pairs --- an integrity zome that defines a data model and a coordinator zome that defines functions for operating on this model. You don't have to do it this way though; coordinator zomes don't need an integrity zome if they don't manipulate data, or they can depend on multiple integrity zomes, or multiple coordinators can depend on the same integrity zome.
46 |
47 | If you mean for your zomes to be reused by other projects, you can share them via a public Git repository or [crates.io](https://crates.io) (tag your crates with `#holochain` so others can find them).
48 |
49 | [Read more on the Zomes page](/build/zomes/).
50 |
51 | ### DNA
52 |
53 | One or more zomes are bundled into a **DNA**, including at least one integrity zome. When two or more agents install and run a DNA, a new peer-to-peer network is created among them to interact and store shared data.
54 |
55 | **A DNA, and the network created for it, is uniquely defined by its integrity zomes, plus any modifiers.** The hash of the integrity zomes plus modifiers is called the **DNA hash**, and is the unique identifier for the network.
56 |
57 | !!! info Why are coordinator zomes not included in the DNA hash?
58 |
59 | Coordinator zomes are bundled with a DNA, but they don't contribute to its hash's uniqueness. That's because they don't constitute the 'rules of the game' for a network like integrity zomes do.
60 |
61 | This means you can hot-swap coordinators as you fix bugs and add features, without changing the DNA hash and creating a new network, which we sometimes call **forking**. The only things that should cause a fork are changes to integrity code.
62 |
63 | !!!
64 |
65 | Because each DNA has its own separate peer network and data store, you can use the DNA concept to come up with creative approaches to [privacy](https://dialnet.unirioja.es/servlet/articulo?codigo=8036267) and access, separation of responsibilities, or data retention.
66 |
67 | [Read more on the DNAs page](/build/dnas/).
68 |
69 | ### hApp {#happ}
70 |
71 | One or more DNAs come together in a **hApp** (Holochain app). Each DNA fills a named **role** in the hApp, and you can think of it like a [microservice](https://en.wikipedia.org/wiki/Microservices).
72 |
73 | Each agent generates their own public/private key pair when they install a hApp. Their public key acts as their **agent ID** which identifies them as a participant in all the networks created for all the DNAs in the hApp. When a DNA is activated, it's bound to this key pair and becomes a **cell**.
74 |
75 | The hApp can specify two provisioning strategies for its DNAs:
76 |
77 | * A cell can be instantiated at app installation time.
78 | * A new cell can be **cloned** from an existing DNA at any time _after the hApp is installed_, with an optional limit on the number of clones.
79 |
80 | A hApp can optionally include a web-based UI that [supporting Holochain runtimes](/get-started/4-packaging-and-distribution/#runtimes) can serve to the user.
81 |
82 | !!! info A hApp always runs locally {#local}
83 |
84 | The big difference with peer-to-peer stacks like Holochain is that **all the code** --- both the back end and the front end --- **runs on the devices of the participants themselves**.
85 |
86 | That means that a DNA doesn't exist as some piece of code that runs 'out there somewhere' --- instead it runs from the perspective of an individual. DNA + agent = cell.
87 |
88 | There can still be bots or system-level services that do automated tasks. Those functions just have to be handled by one of the agents, and that agent doesn't have to be a human.
89 |
90 | !!!
91 |
92 | [Read more on the hApps page](/build/happs/).
93 |
94 | ## Further reading
95 |
96 | * Core Concepts: [Application Architecture](/concepts/2_application_architecture)
--------------------------------------------------------------------------------
/src/pages/build/connecting-a-front-end.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Connecting a Front End"
3 | ---
4 |
5 | ::: intro
6 | Front ends connect to a hApp via the **application API** over a local [WebSocket](https://en.wikipedia.org/wiki/WebSocket) interface. They can call [**zome functions**](/build/zome-functions/) and listen to [**signals**](/concepts/9_signals/), and can also do some app management tasks like **cloning** a cell and getting info about the hApp.
7 | :::
8 |
9 | ## Where a front end runs
10 |
11 | The most important thing to remember about a hApp is that it runs in the Holochain conductor **on each of the devices of the agents themselves**, whether those agents are humans, bots, or headless services. Holochain itself is just an engine for a hApp's back end, so it exposes the hApp's API (its zome functions) and lets front ends connect to the hApp via a WebSocket interface.
12 |
13 | This interface is **only exposed to processes on the local device**, not to external network adapters. This helps prevent unauthorized agents from accessing the hApp. It also means the front end must be distributed with the hApp and a Holochain runtime.
14 |
15 | Some Holochain runtimes bundle the conductor and a front end host that serves your HTML/JavaScript-based runtimes. Take a look at the [Packaging and Distribution](/get-started/4-packaging-and-distribution/) page from the Get Started guide for the choices.
16 |
17 | The Holonix dev environment comes with a runtime called `hc-launch`, which starts Holochain, installs your hApp, and displays a UI for you. The scaffolding tool generates an NPM script that compiles and bundles your back end into a [`.happ` file](/build/happs/#package-a-happ-for-distribution) and starts two instances of the hApp with `hc-launch`. In the root of your project folder, enter:
18 |
19 | ```bash
20 | npm run start
21 | ```
22 |
23 | (If you're using a different package manager, change this command to suit.)
24 |
25 | ## Front-end libraries
26 |
27 | Holochain provides front-end client libraries for [JavaScript](https://github.com/holochain/holochain-client-js) and [Rust](https://github.com/holochain/holochain-client-rust). The scaffolding tool generates JavaScript-based UIs that are meant to be served as a single-page app, so we'll focus on JavaScript for this documentation --- or more specifically TypeScript, because that's what the client library is written in.
28 |
29 | ## Connect to a hApp with the JavaScript client {#connect-to-a-happ-with-the-javascript-client}
30 |
31 | You connect to the application API with the client's [`AppWebsocket.connect`](https://github.com/holochain/holochain-client-js/blob/main/docs/client.appwebsocket.connect.md) method, which returns a Promise<[AppWebsocket](https://github.com/holochain/holochain-client-js/blob/main/docs/client.appwebsocket.md)>.
32 |
33 | If you've been using the scaffolding tool with the UI option, all the code to establish a connection to a hApp is already written for you. You can get it to build reasonable bootstrap code for Lit, React, Svelte, and Vue that makes the client available to child components once it's connected to a hApp.
34 |
35 | But for now, we're going to give you a simple TypeScript example, inspired by the `ui/index.html` file from a hApp scaffolded with the `vanilla` UI option. We'll call on the function in all the following examples, so that we don't have to create a connection every time.
36 |
37 | ```typescript
38 | import { AppWebsocket, HolochainError } from '@holochain/client';
39 |
40 | const getHolochainClient = (() => {
41 | let client: AppWebsocket | undefined;
42 |
43 | return async () => {
44 | if (client === undefined) {
45 | client = await AppWebsocket.connect();
46 | console.log("Connected to Holochain! hApp ID is ${client.installedAppId}");
47 | }
48 | return client;
49 | };
50 | })();
51 |
52 | getHolochainClient().catch((error: HolochainError) => console.error(`Connection failure, name ${error.name}, message ${error.message}`));
53 | ```
54 |
55 | You'll notice that you don't have to pass a connection URI to the client. That's because, at time of writing, all Holochain runtimes that serve a web-based UI will inject a constant into the page that contains the URI, and the client will look for that value. So the scaffolding tool expects you'll be distributing your hApp with one of these runtimes. Check out the [`AppWebsocket.connect` documentation](https://github.com/holochain/holochain-client-js/blob/main/docs/client.appwebsocket.connect.md) if you're building a front end that runs separately from a Holochain runtime.
56 |
57 | ## Reference
58 |
59 | * [`AppWebsocket`](https://github.com/holochain/holochain-client-js/blob/main/docs/client.appwebsocket.md)
60 | * [`AppWebsocket.connect`](https://github.com/holochain/holochain-client-js/blob/main/docs/client.appwebsocket.connect.md)
61 |
62 | ## Further reading
63 |
64 | * [Core Concepts: Application Architecture](/concepts/2_application_architecture/)
--------------------------------------------------------------------------------
/src/pages/build/connecting-the-parts.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Connecting the Parts"
3 | ---
4 |
5 | ::: topic-list
6 | ### In this section {data-no-toc}
7 |
8 | * Connecting the parts (this page)
9 | * [Front end](/build/connecting-a-front-end/) --- establishing a WebSocket connection from JavaScript
10 | * [Calling zome functions](/build/calling-zome-functions) --- examples for front ends, cell-to-cell, and agent-to-agent
11 | * [Capabilities](/build/capabilities/) --- how to manage access to a cell's zome functions
12 | * [Signals](/build/signals/) --- receiving notifications from cells
13 | :::
14 |
15 | ::: intro
16 | Your hApp back end's public interface consists of all the [**zome functions**](/build/zome-functions/) of all the [**cells**](/concepts/2_application_architecture/#cell) instantiated from all the [**DNAs**](/build/dnas/) that fill the hApp's [**roles**](/build/application-structure/#happ). It is accessible to locally running processes and to network peers, and is secured by a form of [**capability-based security**](/build/capabilities/), adapted for peer-to-peer applications.
17 |
18 | The back end can also send out [**signals**](/build/signals/) that can be received either by UIs or remote peers.
19 | :::
20 |
21 | ## What processes can connect to a hApp? {#what-processes-can-connect-to-a-happ}
22 |
23 | It's worth mentioning again that **all the components of a hApp backend [run on the devices of the individual agents](/build/application-structure/#local)** as cells representing those agents' autonomy --- their capacity to write their own data to their own source chains.
24 |
25 | With that in mind, these are the kinds of processes that can make calls to a cell's zome functions:
26 |
27 | 1. another coordinator zome in the same cell
28 | 2. another cell in the same hApp on the agent's device
29 | 3. an external client, such as a UI, script, or system service, on the agent's device
30 | 4. another peer in the same network as the cell (that is, sharing the same DNA hash)
31 |
32 | Of these, only number 3, an external client, can listen to local signals emitted by a zome function. (There's another kind of signal, a remote signal, that's sent between peers in a network. It's actually just a zome function with a special name.)
33 |
34 | ### How does a process connect?
35 |
36 | For cases 1 and 2 above, the Holochain conductor handles inter-process communication between cells. For case 3, Holochain exposes a WebSocket interface for clients to call. And for case 4, the two peers' conductors handle the zome call over the network.
37 |
38 | ## Securing zome functions against unauthorized access
39 |
40 | An agent naturally doesn't want any remote peer calling any of their zome functions, and even local processes should be restricted in case of poorly written DNAs or malware processes on the machine. Holochain uses a modified form of [capability-based security](https://en.wikipedia.org/wiki/Capability-based_security) to secure zome function access.
41 |
42 | Capability-based security, in short, says that you should never give out direct access to a resource such as a file or network connection. Instead you mediate access to that resource and give out 'handles' that represent a set of privileges. Holochain expands on this idea by adding the ability to restrict resource access to a certain group of agents, represented by their private keys.
43 |
44 | [Read more about Holochain's capability security system.](/build/capabilities/)
45 |
46 | ## Sending signals for reactive, event-based programming
47 |
48 | Zome functions can [send out signals](/build/signals/), either locally to front ends or remotely to other agents in the same network. This lets you write programs that react to activity rather than having to poll a function for updates.
49 |
50 | ## Further reading
51 |
52 | * [Core Concepts: Application Architecture](/concepts/2_application_architecture/)
53 | * [Core Concepts: Calls and Capabilities](/concepts/8_calls_capabilities/)
54 | * [Core Concepts: Signals](/concepts/9_signals/)
--------------------------------------------------------------------------------
/src/pages/build/crud-patterns.md:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/pages/build/crud-patterns.md
--------------------------------------------------------------------------------
/src/pages/build/genesis-self-check-callback.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Genesis Self-Check Callback"
3 | ---
4 |
5 | ::: intro
6 | To enforce access control for a network, a DNA can require a [**membrane proof**](/concepts/3_source_chain/#source-chain-your-own-data-store), which is a piece of data that gets entered by the user and written to their [**source chain**](/concepts/3_source_chain/). The `genesis_self_check` function can guard against user entry error and help prevent them from being accidentally marked as a bad actor.
7 | :::
8 |
9 | ## Membrane proof: a joining code for a network
10 |
11 | While a [network seed](/build/dnas/#network-seed) acts like a network-wide passcode, you might need to enforce more fine-grained membership control. You can do this by writing validation code for the contents of the[`AgentValidationPkg`](https://docs.rs/holochain_integrity_types/latest/holochain_integrity_types/action/enum.Action.html#variant.AgentValidationPkg) record. This [**genesis record**](/resources/glossary/#genesis-records) contains data that the user enters on app installation.
12 |
13 | A membrane proof can be basic, like an invite code, or it can be something complex like a signature from an agent that has authority to admit members.
14 |
15 | !!! info Membership control isn't implemented yet
16 | This feature is not fully implemented. Currently, validators merely record a validation failure and supply it on request. Our plan is to connect membrane proof validation outcomes to block lists, so agents can reject connection attempts from a peer with an invalid membrane proof.
17 | !!!
18 |
19 | ## The need for basic pre-validation
20 |
21 | Most useful membrane proofs will require access to network data in order to fully validate them. But an agent can't self-validate their own membership proof at genesis time, because they haven't joined the network yet. This creates a minor problem; they may accidentally type or paste their membrane proof wrong, but won't find out until they try to join the network and get blocked by their peers.
22 |
23 | To reduce the risk, you can define a `genesis_self_check` function that checks the membrane proof before network communications start. This function is limited --- it naturally doesn't have access to DHT data -- but it can be a useful guard against basic data entry errors.
24 |
25 | ## Define a `genesis_self_check` callback
26 |
27 | `genesis_self_check` must take a single argument of type [`GenesisSelfCheckData`](https://docs.rs/hdi/latest/hdi/prelude/type.GenesisSelfCheckData.html) and return a value of type [`ValidateCallbackResult`](https://docs.rs/hdi/latest/hdi/prelude/enum.ValidateCallbackResult.html) wrapped in an `ExternResult`.
28 |
29 | Here's an example that checks that the membrane proof exists and is the right length:
30 |
31 | ```rust
32 | use hdi::prelude::*;
33 |
34 | #[hdk_extern]
35 | pub fn genesis_self_check(data: GenesisSelfCheckData) -> ExternResult {
36 | if let Some(membrane_proof) = data.membrane_proof {
37 | if membrane_proof.bytes().len() == 64 {
38 | return Ok(ValidateCallbackResult::Valid);
39 | }
40 | return Ok(ValidateCallbackResult::Invalid("Membrane proof is not the right length. Please check it and enter it again.".into()));
41 | }
42 | Ok(ValidateCallbackResult::Invalid("This network needs a membrane proof to join.".into()))
43 | }
44 | ```
45 |
46 | This more complex example deserializes an Ed25519 signature and checks that it matches the agent's public key and the public key of an agent with the authority to admit members, which is taken from the DNA's [`properties` block](/build/dnas/#use-dna-properties). {#joining-certificate}
47 |
48 | ```rust
49 | use hdi::prelude::*;
50 | use base64::*;
51 |
52 | // A type for deserializing the DNA properties that this integrity zome needs.
53 | // This struct lets a network creator specify who gets to create joining
54 | // certificates.
55 | #[dna_properties]
56 | pub struct DnaProperties {
57 | // Because the DNA properties are given as YAML, this field should be a
58 | // string that someone can paste in.
59 | authorized_joining_certificate_issuer: AgentPubKeyB64,
60 | }
61 |
62 | #[hdk_extern]
63 | pub fn genesis_self_check(data: GenesisSelfCheckData) -> ExternResult {
64 | let Some(membrane_proof) = data.membrane_proof else {
65 | return Ok(ValidateCallbackResult::Invalid("This network needs a membrane proof to join.".into()));
66 | }
67 |
68 | // Accept a string, because this is something a user can paste into a
69 | // form field.
70 | let Ok(cert: Signature) = std::str::from_utf8(membrane_proof.bytes())
71 | // Expect it to be Base64-encoded; convert it into raw bytes.
72 | .and_then(|s| BASE64_STANDARD::decode(s))
73 | // And then into a Signature.
74 | .and_then(|b| b.try_into())
75 | else {
76 | return Ok(ValidateCallbackResult::Invalid("Couldn't decode membrane proof into joining certificate."));
77 | }
78 |
79 | // Check the certificate against the signing authority.
80 | let dna_props = DnaProperties::try_from_dna_properties()?;
81 | let cert_is_valid = verify_signature(
82 | dna_props.authorized_joining_certificate_issuer,
83 | cert,
84 | data.agent_key
85 | )?;
86 | if cert_is_valid {
87 | return Ok(ValidateCallbackResult::Valid);
88 | } else {
89 | return Ok(ValidateCallbackResult::Invalid("Joining certificate wasn't valid. Please try entering it again or asking the certificate issuer for a new one."));
90 | }
91 | }
92 | ```
93 |
94 | ## Fully validating a membrane proof
95 |
96 | Your `validate` callback also needs to validate a membrane proof in order to actually enforce network access. At the very least, it should apply the same rules as `genesis_self_check` does, and add on any checks that require DHT data. We'll explore this in full on the [`validate` callback](/build/validate-callback/#validate-agent-joining) page.
97 |
98 | ## Reference
99 |
100 | * [`holochain_integrity_types::action::AgentValidationPkg`](https://docs.rs/holochain_integrity_types/latest/holochain_integrity_types/action/enum.Action.html#variant.AgentValidationPkg)
101 | * [`holochain_integrity_types::genesis::GenesisSelfCheckData`](https://docs.rs/holochain_integrity_types/latest/holochain_integrity_types/genesis/type.GenesisSelfCheckData.html)
102 | * [`holochain_integrity_types::validate::ValidateCallbackResult`](https://docs.rs/holochain_integrity_types/latest/holochain_integrity_types/genesis/type.GenesisSelfCheckData.html)
103 | * [`holochain_derive::dna_properties`](https://docs.rs/hdk_derive/latest/hdk_derive/attr.dna_properties.html)
104 |
105 | ## Further reading
106 |
107 | * [Core Concepts: Genesis self-check](/concepts/7_validation/#genesis-self-check)
108 | * [Build Guide: Validation](/build/validation/)
--------------------------------------------------------------------------------
/src/pages/build/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Holochain Build Guide
3 | ---
4 |
5 | !!! note In progress
6 | This guide is under construction. Expect more content to be rapidly published in the first half of 2025.
7 | !!!
8 |
9 | ::: intro
10 | This Build Guide organizes everything you need to know about developing Holochain applications into individual topics. Each topic page stands alone as a comprehensive guide to using a given feature or implementing a given functionality. There are lots of code examples which make it clear how to do something yet are generic enough to be universally useful. These examples may not cover every single use case, though, so we'll point you to the reference documentation often.
11 | :::
12 |
13 | ## Holochain: a very brief overview
14 |
15 | Holochain is a framework for building **peer-to-peer applications**, in which every participant runs the application code on their own device and connects directly to other participants (called their **peers**) to exchange data.
16 |
17 | Holochain's first basic concept is the **agent**, which represents a human or automated participant in a peer-to-peer network. An agent identifies themselves with a self-generated public/private key pair, called their **agent ID**.
18 |
19 | Holochain's second basic concept is the **DNA**, which is a chunk of application back-end code. When you write a Holochain application (which we call a **hApp**), you're writing code that runs sandboxed in a Holochain runtime (called a **conductor**) and responds to function calls from Holochain itself or from external processes such as a UI, system service, or other DNA on the same device, or another peer on the same network.
20 |
21 | When an agent ID is bound to a **DNA**, the live DNA instance is called a **cell** and forms a network with other cells running the same DNA. This network is separate from all other networks formed by other DNAs.
22 |
23 | Now that you've got some basic concepts and the terms we use for them, it's time to dive into application development.
24 |
25 | ## Application structure
26 |
27 | ::: topic-list
28 | * [Overview](/build/application-structure/) --- an overview of Holochain's modularity and composability units
29 | * [Zomes](/build/zomes/) --- integrity vs coordinator, how to structure and compile
30 | * [Lifecycle Events and Callbacks](/build/callbacks-and-lifecycle-hooks/) --- writing functions that respond to events in a hApp's lifecycle
31 | * [Zome Functions](/build/zome-functions/) --- writing your hApp's back-end API
32 | * [DNAs](/build/dnas/) --- what they're used for, how to specify and bundle
33 | * [hApps](/build/happs/) --- headless vs UI-based, how to bundle and distribute
34 | * [Cloning](/build/cloning/) --- working with clones of a DNA
35 | :::
36 |
37 | ## Working with data
38 |
39 | ::: topic-list
40 | * [Overview](/build/working-with-data/) --- general concepts related to working with data in Holochain
41 | * [Identifiers](/build/identifiers) --- working with hashes and other unique IDs
42 | * [Entries](/build/entries/) --- defining, creating, reading, updating, and deleting data
43 | * [Links, Paths, and Anchors](/build/links-paths-and-anchors/) --- creating relationships between data
44 | * [Querying Source Chains](/build/querying-source-chains/) --- getting data from an agent's history
45 | * [Validation Receipts](/build/validation-receipts/) --- discovering the propagation state of data
46 | :::
47 |
48 | ## Using the host API
49 |
50 | ::: topic-list
51 | * [Overview](/build/using-the-host-api/) --- accessing host features from a zome
52 | * [Cell Introspection](/build/cell-introspection/) --- finding out info about the DNA, zome, agent, and calling context
53 | * [Cryptography functions](/build/cryptography-functions/) --- key generation, signatures, hashing, and encryption
54 | * [Miscellaneous host functions](/build/miscellaneous-host-functions/) --- system time, logging, randomness
55 | :::
56 |
57 | ## Connecting the parts
58 |
59 | ::: topic-list
60 | * [Overview](/build/connecting-the-parts/) --- zome calls, capabilities, and signals
61 | * [Front end](/build/connecting-a-front-end/) --- establishing a WebSocket connection from JavaScript
62 | * [Calling zome functions](/build/calling-zome-functions/) --- examples for front ends, cell-to-cell, and agent-to-agent
63 | * [Capabilities](/build/capabilities/) --- how to manage access to a cell's zome functions
64 | * [Signals](/build/signals) --- receiving notifications from cells
65 | :::
66 |
67 | ## Validation
68 |
69 | ::: topic-list
70 | * [Overview](/build/validation/) --- The purpose of validation in a hApp, abilities, requirements and constraints, determinism
71 | * [Genesis Self-Check Callback](/build/genesis-self-check-callback/) --- Purpose and use cases
72 | * [Validate Callback](/build/validate-callback/) --- Writing validation routines for various needs
73 | * [`must_get_*` Host Functions](/build/must-get-host-functions/) --- Deterministically retrieving DHT data for use in validation
74 | * [DHT operations](/build/dht-operations/) --- advanced details on the underlying data structure used in DHT replication and validation
75 |
--------------------------------------------------------------------------------
/src/pages/build/miscellaneous-host-functions.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Miscellaneous Host functions"
3 | ---
4 |
5 | ::: intro
6 | This page contains all the host API functions that don't fit into other categories. It covers system time, randomness, and logging.
7 | :::
8 |
9 | ## Get the system time
10 |
11 | You can get the agent's current system time with the [`sys_time`](https://docs.rs/hdk/latest/hdk/time/fn.sys_time.html) host function, which takes no arguments and returns a result containing a [`Timestamp`](https://docs.rs/kitsune_p2p_timestamp/latest/kitsune_p2p_timestamp/struct.Timestamp.html). _**Note**: This function is only available to coordinator zomes._
12 |
13 | ```rust
14 | use hdk::prelude::*;
15 |
16 | fn get_time() -> ExternResult {
17 | sys_time()
18 | }
19 | ```
20 |
21 | ## Generate some random bytes
22 |
23 | To generate some random bytes, use the [`random_bytes`](https://docs.rs/hdk/latest/hdk/random/fn.random_bytes.html) host function, It takes the number of bytes you want and returns a result containing the bytes, wrapped in a [`Bytes`](https://docs.rs/hdk/latest/hdk/prelude/type.Bytes.html) struct. _**Note**: This function is only available to coordinator zomes._
24 |
25 | ```rust
26 | use hdk::prelude::*;
27 |
28 | fn roll_die(sides: u8) -> ExternResult {
29 | match sides {
30 | 0 => Err(wasm_error!("Can't roll a die with zero sides")),
31 | _ => Ok(random_bytes(1)?[0] % sides + 1),
32 | }
33 | }
34 |
35 | fn reasonably_random_unique_id() -> ExternResult> {
36 | Ok(random_bytes(32)?.into_vec())
37 | }
38 | ```
39 |
40 | !!! info `random_bytes` uses the host operating system's random number generator
41 | Holochain just uses whatever random number generator the host operating system provides. The bytes are open in memory as they're passed to the caller, and they're not provably random or repeatable/seedable. Read the [`random_bytes` Rust documentation](https://docs.rs/hdk/latest/hdk/random/fn.random_bytes.html) to help you decide if this function is appropriate for your use case.
42 | !!!
43 |
44 | ## Log things in your zomes
45 |
46 | You can emit log messages from your zomes using Rust's [`tracing`](https://docs.rs/tracing/latest/tracing/) crate. The HDK includes a tracing subscriber that forwards all your tracing calls to the host. This subscriber is active in any public function marked with the `#[hdk_extern]` macro.
47 |
48 | ```rust
49 | use hdi::prelude::*;
50 |
51 | #[hdk_extern]
52 | pub fn foo() -> ExternResult<()> {
53 | trace!("I am a trace message");
54 | debug!("I am a debug message");
55 | info!("I am an info message");
56 | warn!("I am a warning message");
57 | error!("I am an error message");
58 | }
59 | ```
60 |
61 | To set the logging level appropriate to your needs, set the `WASM_LOG` environment variable just like you'd set the `RUST_LOG` environment variable. The host re-emits the messages to its own tracing subscriber (typically this means outputting them to stdout).
62 |
63 | ```bash
64 | WASM_LOG=info hc-spin workdir/my-app.webhapp
65 | ```
66 |
67 | When the `foo` zome function is called, you'll see:
68 |
69 | ::: output-block
70 | ```text
71 | [hc-spin] | [hc sandbox]: 2025-03-28T21:17:59.566029Z INFO movies:dnas/movies/zomes/coordinator/movies/src/lib.rs:443 I am an info message
72 | [hc-spin] | [hc sandbox]: 2025-03-28T21:17:59.566102Z WARN movies:dnas/movies/zomes/coordinator/movies/src/lib.rs:444 I am a warning message
73 | [hc-spin] | [hc sandbox]: 2025-03-28T21:17:59.566155Z ERROR movies:dnas/movies/zomes/coordinator/movies/src/lib.rs:445 I am an error message
74 | ```
75 | :::
76 |
77 | ## Reference
78 |
79 | * [`hdk::time::sys_time`](https://docs.rs/hdk/latest/hdk/time/fn.sys_time.html)
80 | * [`hdk::random::random_bytes`](https://docs.rs/hdk/latest/hdk/random/fn.random_bytes.html)
81 | * [`hdk::trace` module documentation](https://docs.rs/hdk/latest/hdk/trace/index.html)
82 | * [`tracing` crate documentation](https://docs.rs/tracing/latest/tracing/)
--------------------------------------------------------------------------------
/src/pages/build/using-the-host-api.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Using the Host API"
3 | ---
4 |
5 | ::: topic-list
6 | ### In this section {data-no-toc}
7 |
8 | * Using the Host API (this page)
9 | * [Cell Introspection](/build/cell-introspection/) --- finding out info about the DNA, zome, agent, and calling context
10 | * [Cryptography functions](/build/cryptography-functions/) --- key generation, signatures, hashing, and encryption
11 | * [Miscellaneous host functions](/build/miscellaneous-host-functions/) --- system time, logging, randomness
12 | :::
13 |
14 | ::: intro
15 | Holochain hosts back-end code (**zomes**) in a WebAssembly virtual machine and provides a **host API** to them, which the **HDK** library makes easy to use. It allows agents to read and write data, interact with other cells, and access various other host features.
16 | :::
17 |
18 | ## Accessing the host
19 |
20 | Holochain creates a **sandbox** for zomes to run in, so they can't access the host computer's functionality directly. It exposes a minimal interface for data access, introspection, peer-to-peer interactions, and interop between code modules. You use the HDK (or a minimal subset, the HDI library) to access the host API. The sandbox is implemented as a WebAssembly host, and your zome is a WebAssembly guest.
21 |
22 | !!! info Holochain doesn't expose standard WASM host APIs
23 | Holochain's host API is a small feature set written explicitly for interacting with Holochain's feature set. It doesn't include the WebAssembly JavaScript API or the WebAssembly System Interface (WASI).
24 | !!!
25 |
26 | A lot of this is covered elsewhere already --- [Working with Data](/build/working-with-data/) and [Validation](/build/validation/) talk about data access functions, and [Connecting the Parts](/build/connecting-the-parts/) talks about interop.
27 |
28 | There are a few other functions that don't fall into those categories, so we'll cover them here in three categories: **introspection**, **cryptography**, and **miscellaneous functions**.
--------------------------------------------------------------------------------
/src/pages/concepts/9_signals.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: "Signals: Communicating without waiting for a response"
3 | ---
4 |
5 | ::: intro
6 | A DNA usually only receives function calls from the outside world and returns a response. But a DNA can also push **signals** to a listening client on the agent's device, or another agent on the same network.
7 | :::
8 |
9 | ::: orientation
10 | ### What you'll learn
11 |
12 | 1. [When signals are useful](#when-are-signals-useful)
13 | 2. [Where you can send a signal to](#local-and-remote-signals)
14 | 3. [What signals should not be used for](#when-not-to-use-signals)
15 | 4. [What the future holds](#the-future-pub-sub)
16 |
17 | ### Why it matters
18 |
19 | Signals reduce the need for a client to regularly poll a zome function to retrieve new data, making UIs much more responsive and performant. They can also trigger automatic actions in a cell or client without needing human intervention.
20 | :::
21 |
22 | {.sz80p} {.center}
23 |
24 | ## When are signals useful?
25 |
26 | Most connected applications are heavily interactive. Chat messages appear, notification badges change, documents show real-time updates from collaborators, your opponent moves her knight, and so on. This aliveness is the heartbeat of the modern app.
27 |
28 | So far we've only described a DNA as a collection of functions that you can call. And it is. You can make your app feel fairly responsive by having the UI regularly poll a function such as `get_messages_for_chat_channel`, but this feels old-fashioned and can hurt performance.
29 |
30 | **Signals** extend a DNA's communication ability beyond mere function calls, allowing a cell to broadcast messages to local clients or remote cells. Just like [zome function calls](../8_calls_capabilities/), they pass information to a receiver. But unlike zome function calls, they don't expect the receiver to respond. Like most other payloads, the information is just bytes and can contain any sort of data you like.
31 |
32 | ## Local and remote signals
33 |
34 | There are two kinds of signals. One goes to the client; the other goes to another agent on a DHT.
35 |
36 | ### Local signals
37 |
38 | {.sz80p} {.center}
39 |
40 | When a UI or other client wants to keep up to date on something without initiating any action, they can listen for local signals on the same WebSocket connection they use to make zome calls. The DNA can emit these signals as part of a zome function or other callback. For instance, in [Calls and Capabilities](../8_calls_capabilities/) when Alice calls Bob's `receive_publish_post_permission`, it would be nice to let Bob know he's received that permission. So that function emits a signal to his UI to let him know he's able to publish the article on her behalf now.
41 |
42 | You would typically use this in functions that are not called by a client, such as functions that are meant to be called remotely by other agents in the network, by bridged cells on the user's own machine, or by lifecycle event callbacks such as scheduled functions and post-commit callbacks.
43 |
44 | ### Remote signals
45 |
46 | {.sz80p} {.center}
47 |
48 | Not every peer-to-peer interaction on the DHT needs a response. In cases where Bob doesn't need to know whether his message was received, he can simply send a signal rather than making a remote call.
49 |
50 | This is a lot faster too --- if Bob needs to send a message to fifty people, with remote calls he'd have to make a call to each recipient, wait for a response or a timeout, and move on to the next. Remote signals, on the other hand, let him specify multiple recipients, send off the message, and move on with function execution. The conductor will send it off to all recipients in parallel.
51 |
52 | ## When not to use signals
53 |
54 | As signals don't receive a response, there's no way to tell whether the recipient has actually received the message or acted upon it. It's not safe to use a signal for mission-critical message delivery such as within a [countersigning](../10_countersigning) session. If you do use it to facilitate important activities, make sure there's also a slower but more dependable way of accessing the message's information. For remote signals, this could include Bob following up with Alice via remote calls or publishing the signal data to the DHT; for local signals that update the UI, the UI could also poll for new source chain or DHT data on a slower interval.
55 |
56 | ## The future: pub/sub
57 |
58 | Signals are a fairly simple construct right now, and it's likely that your app will have complex performance or security requirements that mean not all signals should be broadcast everywhere. We intend to introduce a [publish/subscribe](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) model to signals so that clients and remote cells can ask to receive certain messages and not others, while DNA code can approve or reject those requests. We also plan to implement signals for DHT events, such as new entries, [CRUD actions](../6_crud_actions/), or [links](../5_links_anchors/) on a base.
59 |
60 | ## Key takeaways
61 |
62 | * Signals allow a cell to communicate with listeners without expecting a response.
63 | * Signals can be used to avoid
64 | * A signal doesn't have guaranteed delivery because there's no way to tell whether it's been received.
65 | * A signal is simply a message payload consisting of arbitrary bytes.
66 | * Local signals are emitted over the WebSocket application interface to listening clients, and are most useful when emitted from a function call that wasn't triggered by the listening client.
67 | * Remote signals are emitted over the network transport to listening cells within the same network.
68 |
69 | ### Next Up
70 |
71 | [Learn about countersigning →](../10_countersigning/){.btn-purple}
--------------------------------------------------------------------------------
/src/pages/ds/code-fences.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Holochain Dev Portal Design System - Code Fences
3 | layout: ds-layout.njk
4 | layoutId: ds-layout-type
5 | pageStyleId: design-system-code-fences
6 | ---
7 |
8 | Examples of code fence look and feel
9 |
10 |
11 |
12 | ## Code Blocks
13 |
14 | ### With Copy button
15 |
16 | Single line
17 | ```shell
18 | nix run github:/holochain/holochain#hc-scaffold -- web-app
19 | ```
20 |
21 | Multiple line
22 | ```text
23 | ? Choose UI framework: ›
24 | ❯ Vue
25 | Svelte
26 | Lit
27 | ```
28 |
29 | ### Without Copy button
30 |
31 | To surpress the copy button you can wrap the code block in a `::: output-block` container
32 |
33 | Single line
34 | ::: output-block
35 | ```shell
36 | nix run github:/holochain/holochain#hc-scaffold -- web-app
37 | ```
38 |
39 | Multiple line
40 | ```text
41 | ? Choose UI framework: ›
42 | ❯ Vue
43 | Svelte
44 | Lit
45 | ```
46 | :::
47 |
48 |
--------------------------------------------------------------------------------
/src/pages/ds/containers.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Holochain Dev Portal Design System - Code Fences
3 | layout: ds-layout.njk
4 | layoutId: ds-layout-type
5 | pageStyleId: design-system-containers
6 | ---
7 |
8 | !!! note
9 | To avoid the meta-ness of trying to code-fence markdown, please look at the source .md files for how to write the markdown. The browser version will serve as reference of what it will look like. Also note that most of these elements are not standard md so they will not show up in their final expression in the Github or VS Code previews.
10 | !!!
11 |
12 | There are a number of custom extensions to the `markdown-it-container` plugin that we have implemented.
13 | Note: `markdown-it-container` requires that each container be specifically implemented, so you can't just use `!!! newblock` or similar.
14 |
15 | Accept as noted attribute blocks (exp: `{#an-id .a-class target=_blank}`) will be honored and express as attributes in the resulting tag.
16 |
17 | ## Details
18 | Render a Detail/Summary block.
19 | !!! details The summary text
20 | sit amet tellus cras adipiscing enim eu turpis egestas pretium aenean pharetra magna ac placerat vestibulum lectus mauris ultrices eros in cursus turpis massa tincidunt dui ut ornare lectus sit
21 | !!!
22 |
23 | The contents of the details tag after the summary tag is wrapped in a div with a class of `details-content`. If an attributes block is applied to the `details` line the attributes are applied to overall `` tag.
24 |
25 | Details synonyms: These get the block name as an extra class name.
26 | !!! dig-deeper The Dig Deeper summary text
27 | sit amet tellus cras adipiscing enim eu turpis egestas pretium aenean pharetra magna ac placerat vestibulum lectus mauris ultrices eros in cursus turpis massa tincidunt dui ut ornare lectus sit
28 | !!!
29 |
30 | ## Output Block
31 | Can wrap around code fences to prevent Copy buttons form being added to the code block. See [Code Fences](../code-fences/) for details.
32 |
33 | ## Admonitions
34 |
35 | - ### Tip
36 | #### No Title
37 | !!! tip {#tip}
38 | Tip contents
39 | !!!
40 |
41 | #### With a Title
42 | !!! tip Very Impressive Title Text
43 | Tip contents
44 | !!!
45 |
46 | - ### Note
47 | #### No Title
48 | !!! note
49 | Note contents
50 | !!!
51 |
52 | #### With a Title
53 | !!! note Very Impressive Title Text
54 | Note contents
55 | !!!
56 |
57 | - ### Info
58 | #### No Title
59 | !!! info
60 | Info contents
61 | !!!
62 |
63 | #### With a Title
64 | !!! info Very Impressive Title Text
65 | Info contents
66 | !!!
67 |
68 | - ### Learn
69 | #### No Title
70 | !!! learn
71 | Learn contents
72 | !!!
73 |
74 | #### With a Title
75 | !!! learn Very Impressive Title Text
76 | Learn contents
77 | !!!
78 |
79 | ## Site content specific containers
80 | All the below just apply a specific class to a surrounding div. These were implemented for very specific site style needs. More such can be created if need be.
81 |
82 | - ### intro
83 | ::: intro
84 | Sit amet tellus cras adipiscing enim eu turpis egestas. Pretium aenean pharetra magna ac placerat vestibulum lectus mauris ultrices eros in cursus turpis massa tincidunt dui ut ornare lectus sit.
85 | :::
86 |
87 | - ### orientation
88 | ::: orientation
89 | Sit amet tellus cras adipiscing enim eu turpis egestas. Pretium aenean pharetra magna ac placerat vestibulum lectus mauris ultrices eros in cursus turpis massa tincidunt dui ut ornare lectus sit.
90 | :::
91 |
92 | - ### storystep
93 | ::: storystep
94 | Sit amet tellus cras adipiscing enim eu turpis egestas. Pretium aenean pharetra magna ac placerat vestibulum lectus mauris ultrices eros in cursus turpis massa tincidunt dui ut ornare lectus sit.
95 | :::
96 |
97 |
--------------------------------------------------------------------------------
/src/pages/ds/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Holochain Dev Portal Design System
3 | layout: ds-layout.njk
4 | layoutId: ds-layout-type
5 | pageStyleId: design-system
6 | ---
7 |
8 | A collection of design elements used in the Dev Portal for reference and UX review. Not intended to be linked to in public sources.
9 |
10 | !!! note
11 | To avoid the meta-ness of trying to code-fence markdown, please look at the source .md files for how to write the markdown. The browser version will serve as reference of what it will look like. Also note that most of these elements are not standard md so they will not show up in their final expression in the Github or VS Code previews.
12 | !!!
13 |
14 | [Code Fences](./code-fences/)
15 |
16 | [Containers](./containers/)
--------------------------------------------------------------------------------
/src/pages/favicon.ico:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/holochain/docs-pages/13eafef227d00c7b1e16e9f902944040a2ce6644/src/pages/favicon.ico
--------------------------------------------------------------------------------
/src/pages/get-involved.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Get Involved
3 | ---
4 |
5 | Regardless of your experience level as a developer, we encourage you to get involved and stay connected. Here are a few ways to start:
6 |
7 | ### Jump in and get your feet wet
8 |
9 | * Read through our [Core Concepts](/concepts/1_the_basics/)
10 | * Track development progress with the biweekly [Holochain Dev Pulse](https://blog.holochain.org/tag/dev-pulse/)
11 |
12 | ### Connect and contribute
13 |
14 | * Discuss everything related to Holochain and hApp development in the [DEV.HC channel on Discord](https://discord.gg/MwPvM4Vffg)
15 | * Contribute to the conversation on our [Holochain Developer Forum](https://forum.holochain.org/)
16 | * Sign up for the [Holochain Blog](http://blog.holochain.org#subscribe) to stay up to date
17 | * Follow us on social media ([Facebook](https://www.facebook.com/holochain.design) and [Twitter](https://twitter.com/holochain))
18 |
--------------------------------------------------------------------------------
/src/pages/get-started/at-an-event.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Getting Set Up For a Local Event
3 | ---
4 |
5 | ## Prepare your development environment
6 |
7 | If you have not already done so, please follow the first step in the [Get Started](/get-started/) guide which asks you to run the `setup.sh` script. Then you should come back to this page and configure the local cache before proceeding with verifying your Nix setup in the quick start guide.
8 |
9 | The rest of this guide assumes you have either done this or created an equivalent environment manually.
10 |
11 | ## Configure Nix to use a local cache
12 |
13 |
14 | The quick start `setup.sh` script configures Nix to use `https://holochain-ci.cachix.org` as a cache. This significantly speeds up launching the Holonix development environment. It works well for individuals, but at live events it requires a lot of bandwidth with multiple people downloading large amounts of files at the same time. To improve the experience for everyone, a cache can be provided locally. This section shows you how to connect to the local cache.
15 |
16 | The event hosts need to provide you with a cache name. This will be unique per event! Replace `` with the provided name in the command below.
17 |
18 | At a command line:
19 |
20 | ```shell
21 | bash <(curl https://holochain.github.io/holochain/configure-cache.sh) use
22 | ```
23 |
24 | The script will tell you what it's changing and may ask for confirmation for some changes. It may also prompt for your password if it needs to make changes to files owned by the root user.
25 |
26 | At the end of the event, you shouldn't keep these configuration changes. You can run another command to remove all the configuration that the first command added.
27 |
28 | At a command line:
29 |
30 | ```shell
31 | bash <(curl https://holochain.github.io/holochain/configure-cache.sh) cleanup
32 | ```
33 |
--------------------------------------------------------------------------------
/src/pages/get-started/distribute-your-app.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Distribute your App
3 | ---
4 |
5 | ## Packaging a Web-hApp archive
6 |
7 | At some stage in the app development you'll want to deploy your hApp for others to use it. For this, you will need to package it into a `.webhapp` file that contains both the back-end and the front-end code of your hApp.
8 |
9 | If you've created the hApp with the `hc scaffold` cli tool, all you need to do is:
10 |
11 | ```shell
12 | npm run package
13 | ```
14 |
15 | The app bundle ending in `.webhapp` will be available in the project root's `workdir` folder. Now you can deploy it to a place where users can download it or directly share it with peers you want to use it with.
16 |
17 | To bundle manually and for extended details on Web-hApps, refer to the packaging steps in the [Github repo of the Holochain Launcher](https://github.com/holochain/launcher#packaging-a-web-happ).
18 |
19 | ## Installing the app using the Holochain Launcher
20 |
21 | Holochain provides the Holochain Launcher, a graphical user interface, to install, run and administrate hApps. [Download Holochain Launcher](https://github.com/holochain/launcher/releases)
22 |
23 | To publicly share your bundled hApp through the Holochain Launcher, follow the [instructions on how to publish it to the DevHub](https://github.com/holochain/launcher#publishing-and-updating-an-app-in-the-devhub) in the README of the Holochain Launcher.
24 |
25 | Another option is to [install a hApp locally from an app bundle on the file system](https://github.com/holochain/launcher#installing-a-holochain-app-happ). Other users will need to obtain the bundled app file and install it to their Launcher.
--------------------------------------------------------------------------------
/src/pages/get-started/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Get Started
3 | ---
4 |
5 | Welcome to the Getting Started with Holochain guide! This is a four-page guide which will walk you through the process of installing the Holochain development tools and creating a simple forum application. By the end of this guide, you'll be familiar with the core concepts of Holochain and have a basic understanding of how to develop peer-to-peer applications using the Holochain framework.
6 |
7 | ## How to use this guide
8 |
9 | Follow this guide step by step. All steps are essential to create the example applications. No additional code or steps are needed.
10 |
11 | There's a lot of additional explanation that isn't necessary for building the application, but it'll help you understand what you're doing in more depth. Look for the book icon and the 'Learn more' heading.
12 |
13 | * The examples below use `$` to represent your terminal prompt in a UNIX-like OS, though it may have been customized in your OS to appear differently.
14 | * We assume that you are reading this guide because you're a developer who's new to Holochain but is interested in actually building peer-to-peer distributed applications using a framework that is agent-centric, that provides intrinsic data integrity, is scalable, and runs just on the devices of the participants without relying on centralized servers, blockchain tokens, or other points of centralized control.
15 | * We assume that you've at least skimmed [Holochain's Core Concepts](/concepts/1_the_basics/) or are ready to pop over there when needed.
16 | * Because Holochain's DNAs are written in Rust, we assume you have at least a basic familiarity with the language. Note, however, that this guide will take you through everything you need to do, step-by-step, so you can follow the steps and learn Rust later. Additionally, Holochain DNAs rarely need to take advantage of the more complicated aspects of the language, so don't let Rust's learning curve scare you.
17 | * If you're new to Rust, you can start your learning journey by reading chapters 1 to 11 in the [Rust Book](https://doc.rust-lang.org/book/) and doing the accompanying [Rustlings exercises](https://github.com/rust-lang/rustlings/).
18 | * We also assume that you have basic familiarity with the Unix command line.
19 |
20 | ## 1. Introduction to Holochain
21 |
22 | Holochain is a framework for building peer-to-peer distributed applications, also known as hApps. It emphasizes agent-centric architecture, intrinsic data integrity, and scalability. Holochain enables developers to build applications that run on just the devices of the participants without relying on centralized servers or blockchain tokens.
23 |
24 | ## 2. Installing Holochain development environment
25 |
26 | In this section, we'll walk you through the step-by-step process of installing Holochain, its dependencies, and developer tools on your system so that you can develop hApps.
27 |
28 | ### 2.1. Hardware requirements
29 |
30 | Before you install the Holochain development environment, make sure your system meets the following hardware requirements:
31 |
32 | * 8GB+ RAM (16GB+ recommended)
33 | * 4+ cores CPU (6+ cores recommended)
34 | * 30GB+ available disk space
35 | * High-speed internet connection
36 |
37 | This may seem like a lot; it's mainly due to Rust's compiler, which requires a lot of system resources.
38 |
39 | ### 2.2. Windows prerequisite: WSL2 {#2-2-windows-prerequisite-wsl2}
40 |
41 | For Windows users, please note that the Nix package manager, which is used to install and manage the Holochain development environment, only supports macOS and Linux. You'll need to [install Linux under Windows with WSL2 (Windows Subsystem for Linux)](https://learn.microsoft.com/en-us/windows/wsl/install) (recommended) or dual-boot a Linux OS alongside your [Windows 10](https://www.freecodecamp.org/news/how-to-dual-boot-windows-10-and-ubuntu-linux-dual-booting-tutorial/) or [Windows 11](https://www.xda-developers.com/dual-boot-windows-11-linux/) OS to proceed.
42 |
43 | Holochain is supported in WSL2 via the Ubuntu distribution.
44 |
45 | You'll also need to install a few packages if you want to run two dev tools, `hc spin` and `hc launch`, which start your app's back end and open its GUI in Electron or Tauri webviews:
46 |
47 | ```shell
48 | sudo apt install -y libnss3 libatk1.0-0 libatk-bridge2.0-0 libcups2 libgtk-3-dev libasound2t64 adwaita-icon-theme
49 | ```
50 |
51 | Read more about these fixes in the [Dev Tools Setup guide](/get-started/install-advanced/#opening-your-happs-gui-in-ubuntu-on-wsl2).
52 |
53 | ### 2.3. Set up development environment
54 |
55 | Once you've ensured that your system meets the hardware requirements and set up WSL2 on Windows or a dual-boot Linux OS (if applicable), you can proceed with the installation of the Nix package manager and the binary package cache for Holochain.
56 |
57 | Open a command-line terminal ([on Linux](https://ubuntu.com/tutorials/command-line-for-beginners#3-opening-a-terminal), [on macOS](https://support.apple.com/en-gb/guide/terminal/pht23b129fed/mac)) and run the following command:
58 |
59 | ```shell
60 | bash <(curl https://holochain.github.io/holochain/setup.sh)
61 | ```
62 |
63 | This command downloads the setup script and runs it, installing the Nix package manager and setting up a package cache for Holochain.
64 |
65 | ### 2.4. Verify installation
66 |
67 | In a new terminal session type:
68 |
69 |
70 |
71 | ```shell
72 | nix run --refresh -j0 -v "github:holochain/holonix?ref=main-0.5#hc-scaffold" -- --version
73 | ```
74 |
75 | Look out for binaries being copied from `holochain-ci.cachix.org`:
76 |
77 | ::: output-block
78 | ```text
79 | downloading 'https://holochain-ci.cachix.org/nar/.nar.zst'...
80 | ```
81 | :::
82 |
83 | It proves that the package cache is configured correctly.
84 |
85 | At the end of the output, Holochain's scaffolding tool should print its version string, which will be something like this:
86 |
87 |
88 | ::: output-block
89 | ```text
90 | holochain_scaffolding_cli 0.500.0
91 | ```
92 | :::
93 |
94 | Congratulations! The Holochain development environment is now set up successfully on your system.
95 |
96 | ### Next up
97 |
98 | Now it's time to download, compile, and try an example Holochain application.
99 |
100 | [Try 'Hello World' →](/get-started/2-hello-world/){.btn-purple}
--------------------------------------------------------------------------------
/src/pages/get-started/install-without-nix.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Setup without Nix (currently unsupported)
3 | hide:
4 | - toc
5 | ---
6 |
7 | ::: intro
8 | If you ended up here because you ran into problems with the [Nix based quick installation guide](/get-started/), we would greatly appreciate if you let us know what went wrong by [creating a bug report](https://github.com/holochain/docs-pages/issues/new/choose) so that we can look into it.
9 | :::
10 |
11 | !!! note Unsupported
12 | Holonix is the recommended way to set up your development environment.
13 | **We don't provide support for installing Holochain without Holonix.**
14 | !!!
15 |
16 | ## Install Holochain without Holonix
17 |
18 | In case you don't want to use Holonix to set up your development environment, here are the steps provided to install Holochain binaries directly
19 | from the crate registry. At first the required Rust toolchain and features are installed, followed by the actual Holochain dependencies.
20 |
21 |
22 | ### Ubuntu-based Linux distributions
23 |
24 | #### Install the Rust toolchain and build dependencies
25 |
26 | 1. Follow the official [Rust toolchain installation](https://www.rust-lang.org/tools/install)
27 | 2. Install the required target to build WebAssembly binaries
28 | ```shell
29 | rustup target add wasm32-unknown-unknown
30 | ```
31 | 3. Linux build tools
32 | ```shell
33 | sudo apt-get install build-essential
34 | ```
35 | 4. OpenSSL
36 | ```shell
37 | sudo apt-get install libssl-dev
38 | ```
39 | 5. Build dependency for Cargo libraries
40 | ```shell
41 | sudo apt-get install pkg-config
42 | ```
43 |
44 | #### Install Holochain binaries
45 |
46 | The following commands will compile and install the binaries into your user's profile.
47 | It will overwrite any pre-existing binaries, also in the case where its already the latest version.
48 |
49 | ```shell
50 | cargo install --force holochain
51 | ```
52 | ```shell
53 | cargo install --force holochain_cli
54 | ```
55 | ```shell
56 | cargo install --force lair_keystore
57 | ```
58 | ```shell
59 | cargo install --force holochain_cli_launch
60 | ```
61 | ```shell
62 | cargo install --force holochain_scaffolding_cli
63 | ```
--------------------------------------------------------------------------------
/src/pages/index.njk:
--------------------------------------------------------------------------------
1 | ---
2 | title: Holochain Developer Portal
3 | layout: default-page-layout.njk
4 | pageStyleId: home-page
5 | surpressH1InLayout: true
6 | ---
7 |
8 | {% layoutblock "abovePageWrap" %}
9 |
10 |
15 |
16 |
17 |
18 |
19 |
24 |
25 |
26 |
Holochain
27 |
A framework for building distributed P2P apps
28 | Get Started
29 |
30 | {% endlayoutblock %}
31 |
32 | {% include "src/pages/_includes/widgets/home-tiles.njk" %}
33 |
34 |
35 |
36 |
37 |
38 |
Serverless
39 |
The community is the infrastructure. Scale with the popularity of your app.
40 |
41 |
42 |
43 |
Connectable
44 |
Access other Holochain apps as if they were part of your codebase. No HTTP client, just function calls with optional access control.
45 |
46 |
47 |
48 |
Resilient
49 |
Compute and data live at the edges, which means there’s no infrastructure for you to maintain and defend.
11 | 
11 | 
40 |