docs: book updates

This commit is contained in:
Ben Allfree 2023-06-10 03:53:09 -07:00
parent aecea67fb1
commit 84b0a7de04
7 changed files with 14 additions and 8 deletions

View File

@ -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.

View File

@ -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)

View File

@ -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).

View File

@ -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**

View File

@ -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.