openstatus icon indicating copy to clipboard operation
openstatus copied to clipboard

The Docs are unhelpful - unable to get started even after exactly following getting started - irony

Open nikhil-swamix opened this issue 3 months ago • 11 comments

Reproduction / Replay Link (Optional)

No response

Description

I tried all the variations of commands

Image

1926 curl -sSL instl.sh/openstatushq/cli/linux | bash 1927 openstatus 1928 openstatus monitors 1929 openstatus run 1930 pnpm install 1931 turso dev --db-file openstatus-dev.db 1932 pnpm i -g turso 1933 pnpm setup 1934 source /root/.bashrc 1935 pnpm i -g turso 1936 turso dev --db-file openstatus-dev.db 1937 npm i -g turso 1938 turso dev --db-file openstatus-dev.db 1939 turso 1940 curl -sSfL https://get.tur.so/install.sh | bash 1941 turso 1942 sudo turso 1943 cd /home//statuspages/ 1944 pnpm dx 1945 pnpm dev:web 1946 fuser 1947 fuser -k 1948 fuser -k tcp/3000 1949 fuser -k tcp\3000 1950 sudo fuser -k 3000/tcp 1951 pnpm dev:web 1952 sudo pnpm dev:web 1953 sudo npm dev:web 1954 sudo npm run dev:web 1955 turso 1956 which turso 1957 pnpm i 1958 pnpm approve-builds 1959 pnpm i 1960 pnpm approve-builds 1961 pnpm i 1962 sudo npm run dev:web 1963 curl -sSfL https://get.tur.so/install.sh | bash 1964 sudo npm run dev:web 1965 export PATH="$HOME/.turso/bin:$PATH" 1966 source ~/.bashrc 1967 sudo npm install -g turso-cli 1968 turso --version 1969 sudo npm run dev:web 1970 history

Environment

Need to install the following packages:
[email protected]
Ok to proceed? (y) y


  System:
    OS: Linux 5.15 Ubuntu 24.04.2 LTS 24.04.2 LTS (Noble Numbat)
    CPU: (32) x64 Intel(R) Core(TM) i9-14900HX
    Memory: 14.11 GB / 15.62 GB
    Container: Yes
    Shell: 5.2.21 - /bin/bash
  Binaries:
    Node: 24.6.0 - ~/.nvm/versions/node/v24.6.0/bin/node
    npm: 11.5.1 - ~/.nvm/versions/node/v24.6.0/bin/npm
    pnpm: 10.12.4 - /usr/local/bin/pnpm
    bun: 1.2.20 - ~/.bun/bin/bun
  Browsers:
    Chrome: 139.0.7258.66
    Chromium: 139.0.7258.138
  npmPackages:
    @biomejs/biome: 1.8.3 => 1.8.3
    @turbo/gen: 1.13.3 => 1.13.3
    @types/node: 20.8.0 => 20.8.0
    knip: 5.16.0 => 5.16.0
    turbo: 2.3.2 => 2.3.2
    typescript: 5.7.2 => 5.7.2

nikhil-swamix avatar Sep 18 '25 11:09 nikhil-swamix

@nikhil-swamix Thanks for reporting this

How you do install the turso cli ? because its not a npm package ?

thibaultleouay avatar Sep 18 '25 12:09 thibaultleouay

I agree, the documentation is very vague. We need instructions that are completely clear and specific. It feels like this is more marketing than true open source - make the docs poor and installation difficult so people feel pushed to buy the cloud hosted version.

ronilaukkarinen avatar Sep 28 '25 18:09 ronilaukkarinen

@ronilaukkarinen I know our docs are not perfect but yeah if people move to the cloud hosted one we will have more money and time to improve it :)

We have an open issue to have a docker compose #322 feel free to contribute it

@mxkaske and I both have jobs on the side and don't make a living out of open-source

Please be kind and support us 🤗

ps: if you look at the screenshot provide above it's an issue with the turso cli and i tried to help @nikhil-swamix :)

thibaultleouay avatar Sep 28 '25 18:09 thibaultleouay

I wasn't trying to be rude - sorry if it came across that way. I'm just sharing my perspective as someone who runs a company but also contributes daily to open source and releases full projects for free. I can submit a PR to the README.md once I get this running from source properly. Right now, "Install project dependencies, build and start services" feels more like "good luck" 😅

ronilaukkarinen avatar Sep 28 '25 18:09 ronilaukkarinen

Update: From what I've gathered, this infrastructure needs at least three systemd services: openstatus-turso.service, openstatus-web.service, and openstatus-dashboard.service + reverse proxy for domain access. However, many parts seem hardcoded for the SaaS version - for example, the main view opens a marketing page, and the production build process runs out of memory even on an 8GB RAM machine. It really doesn't feel "production ready" as an open source version.

ronilaukkarinen avatar Sep 28 '25 20:09 ronilaukkarinen

No worries @ronilaukkarinen

Here I break down what we need to run for OpenStatus self-hosting. https://github.com/openstatusHQ/openstatus/issues/322#issuecomment-3178105803

The status page and the web (marketing landing are getting split in current work).

Yeah, some parts are hardcoded (for example, we use a GCP queue for queuing checks).

For Turso, if it's on the same machine, you can use a SQLite database or run the LibSQL Docker image. It's production-ready for the cloud, but it's not 'production ready' for the self-hosted version because it's not easily self-hostable, true.

thibaultleouay avatar Sep 29 '25 07:09 thibaultleouay

I agree, the documentation is very vague. We need instructions that are completely clear and specific. It feels like this is more marketing than true open source - make the docs poor and installation difficult so people feel pushed to buy the cloud hosted version.

Yap.. yet another "open source" project.

GomoDD avatar Oct 23 '25 07:10 GomoDD

@GomoDD Please help us improve it :)

Let us know which part should be improved and would be happy to include it :)

thibaultleouay avatar Oct 23 '25 07:10 thibaultleouay

@GomoDD Please help us improve it :)

Let us know which part should be improved and would be happy to include it :)

This exact response confirms my comment.

GomoDD avatar Oct 23 '25 08:10 GomoDD

@GomoDD Please help us improve it :) Let us know which part should be improved and would be happy to include it :)

This exact response confirms my comment.

WDYM? I don't get it 🤔

thibaultleouay avatar Oct 23 '25 08:10 thibaultleouay

I agree, the documentation is very vague. We need instructions that are completely clear and specific. It feels like this is more marketing than true open source - make the docs poor and installation difficult so people feel pushed to buy the cloud hosted version.

Yap.. yet another "open source" project.

Maybe just they have no time to expend yet on good documentation. lets help them and us on make this another good "open source".

Relax just read about @thibaultleouay approach of open source self-hostable

https://github.com/openstatusHQ/openstatus/issues/322#issuecomment-2708146358

joelop3 avatar Nov 26 '25 16:11 joelop3