diff --git a/gitbook/README.md b/gitbook/README.md index 9bd642df..a24e82de 100644 --- a/gitbook/README.md +++ b/gitbook/README.md @@ -40,5 +40,3 @@ Here's all the Linux/devops stuff that PocketHost does for you: - CDN and static asset hosting - Amazon AWS - Lots more - scaling, firewalls, DDoS defense, user security, log rotation, patches, updates, build tools, CPU architectures, multitenancy, on and on - -This monorepo contains the entire open source stack that powers pockethost.io. You can use it to run your own private or public multitenant platform. diff --git a/gitbook/SUMMARY.md b/gitbook/SUMMARY.md index 3af449a1..603bcfcd 100644 --- a/gitbook/SUMMARY.md +++ b/gitbook/SUMMARY.md @@ -4,13 +4,14 @@ ## Development +- [Overview](development/overview.md) +- [Roadmap](development/roadmap.md) - [Running Just the Frontend](development/frontend.md) -- [Running Everything](development/full-stack.md) +- [Running Everything](development/full-stack/readme.md) - [Production Deployment](development/production.md) ## Release History -- [Roadmap](development/roadmap.md) - [next](releases/next.md) - [0.7.0](releases/0.7.0.md) - [0.6.1](releases/0.6.1.md) diff --git a/docs/dnsmasq.md b/gitbook/development/full-stack/dnsmasq.md similarity index 100% rename from docs/dnsmasq.md rename to gitbook/development/full-stack/dnsmasq.md diff --git a/docs/etc_hosts.md b/gitbook/development/full-stack/etc_hosts.md similarity index 100% rename from docs/etc_hosts.md rename to gitbook/development/full-stack/etc_hosts.md diff --git a/docs/local-domain-setup.md b/gitbook/development/full-stack/local-domain-setup.md similarity index 78% rename from docs/local-domain-setup.md rename to gitbook/development/full-stack/local-domain-setup.md index a51484b8..ef367cce 100644 --- a/docs/local-domain-setup.md +++ b/gitbook/development/full-stack/local-domain-setup.md @@ -1,6 +1,6 @@ # Local Domain Setup Instructions -This document covers how to set up your local development environment to recongize wildcard domains with SSL. Developing the full Dockerized stack for PocketHost requires these steps. +This document covers how to set up your local development environment to recognize wildcard domains with SSL. Developing the full Dockerized stack for PocketHost requires these steps. **1. Generate a root certificate for self-signing.** @@ -29,7 +29,7 @@ For other browsers and operating systems, follow the instructions here: https:// **4. Configure your machine to recognize wildcard localhost domains.** -If you are on OS X, follow the [dnsmasq instructions](./dnsmasq.md) to set up your local machine for the ultimate local domain wildcard dev experience. +If you are on OS X, follow the [dnsmasq instructions](dnsmasq.md) to set up your local machine for the ultimate local domain wildcard dev experience. Remember to start `dnsmasq` every time: @@ -37,4 +37,4 @@ Remember to start `dnsmasq` every time: brew services restart dnsmasq ``` -If you don't want to use `dnsmasq`, follow the [manual /etc/hosts setup instructions](./etc_hosts.md). +If you don't want to use `dnsmasq`, follow the [manual /etc/hosts setup instructions](etc_hosts.md). diff --git a/gitbook/development/full-stack.md b/gitbook/development/full-stack/readme.md similarity index 96% rename from gitbook/development/full-stack.md rename to gitbook/development/full-stack/readme.md index 3e0cde06..8aed1b9b 100644 --- a/gitbook/development/full-stack.md +++ b/gitbook/development/full-stack/readme.md @@ -4,7 +4,7 @@ The entire pockethost.io stack can be run locally. **Prerequisites** -- Local SSL wildcard domain - [local domain setup instructions](./docs/local-domain-setup.md) +- Local SSL wildcard domain - [local domain setup instructions](local-domain-setup.md) **Running in dev mode** diff --git a/gitbook/development/overview.md b/gitbook/development/overview.md new file mode 100644 index 00000000..d0ff8fe9 --- /dev/null +++ b/gitbook/development/overview.md @@ -0,0 +1,7 @@ +# Developing PocketHost + +This monorepo contains the entire open source stack that powers pockethost.io. You can use it to run your own private or public multitenant platform. + +PocketHost is a pure nodejs application. It used to run in a Docker container, but it was eventually decided that a pure node stack was a better option. + +If you are interested in contributing, modifying the frontend is definitely easiest. Modifying the backend takes some extra setup.