Official docs, website, and handbook for PostHog.
Support - Roadmap - Open an issue - Style guide
This is the repository for the PostHog website. It contains:
Pre-installation
Install Node and Yarn. (If you're on a Mac with Apple Silicon and get an error with -86
in it, you may need to install Rosetta.)
npm install --global yarn
Start developing
Clone the repo then navigate into your new site’s directory, install the site dependencies, and start it up.
cd posthog.com/
yarn
yarn start
Tip: Seeing a discrepancy between local development and staging/production? Preview the production build locally by running
gatsby build && gatsby serve
Open the source code and start editing!
Your site is now running at http://localhost:8001
!
Note: You'll also see a second link:
http://localhost:8001/___graphql
. This is a tool you can use to experiment with querying your data. Learn more about using this tool in the Gatsby tutorial.
See full instructions on developing PostHog.com locally in our manual.
It is also possible to use Docker to run posthog.com locally with this command:
docker run -it --rm \
-w /app -v "$PWD":/app \
-p 8000-8001:8000-8001 \
-e INTERNAL_STATUS_PORT=8001 \
node:14-slim \
sh -c 'yarn && yarn start'
master
gatsby clean && yarn start
or delete node_modules
and .cache
/docs/api
?The site will load the API schema from US Cloud by default. You can override this to use your local PostHog instance with an env var:
POSTHOG_OPEN_API_SPEC_URL="http://127.0.0.1:8000/api/schema/" yarn start
You’ll need to set environment variables for these. See (private) instructions for this.
To see your local version of the posts section, /posts
needs to be visited directly (http://localhost:8001/posts
)
Additional environment variables are needed to develop the merch store:
SHOPIFY_APP_PASSWORD
GATSBY_MYSHOPIFY_URL
GATSBY_SHOPIFY_STOREFRONT_TOKEN
Currently, these environment variables are excluded from Vercel preview builds to disable merch store node creation and speed up build times on non-merch related PRs.
We <3 contributions big and small. In priority order (although everything is appreciated) with the most helpful first: