Skip to content

docs(dev): update dev docs to use dashboard #342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
auxesis merged 2 commits into from
Dec 17, 2025
Merged

docs(dev): update dev docs to use dashboard #342

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e65064
docs(dev): update dev docs to use dashboard
auxesis Dec 16, 2025
f5dc4f7
docs: specify a full URL, to make it clickable
auxesis Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 18 additions & 31 deletions DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,37 +26,24 @@ mise run postgres:up --extra-args "--detach --wait"
# Install latest eql into database
mise run postgres:setup

# If this is your first time using CipherStash:
# - install stash CLI
# - `stash signup`

# If you have used CipherStash before:
# - `stash login`

# Create minimal mise.local.toml
# CS_WORKSPACE_CRN
# CS_CLIENT_ACCESS_KEY
# CS_DEFAULT_KEYSET_ID
# CS_CLIENT_KEY
# CS_CLIENT_ID

# Get the workspace ID
stash workspaces
# add to CS_WORKSPACE_CRN in the format: "crn:region:workspace-id" - eg. "crn:ap-southeast-2.aws:7WXWMKXKQU42PDB4"
# NOTE: this is going to change so `stash workspaces` will return CRNs instead of IDs

# Create an access key
stash access-keys create proxy
# add to CS_CLIENT_ACCESS_KEY

# Create a dataset
stash keysets create proxy
# add to CS_DEFAULT_KEYSET_ID

# Create a client
stash clients create --keyset-id $DEFAULT_KEYSET_ID proxy
# add to CS_CLIENT_ID
# add to CS_CLIENT_KEY
# Create a stub mise.local.toml
cat > mise.local.toml << 'EOF'
[env]
CS_WORKSPACE_CRN = ""
CS_CLIENT_KEY = ""
CS_CLIENT_ID = ""
CS_CLIENT_ACCESS_KEY = ""
CS_DEFAULT_KEYSET_ID = ""
Comment on lines +33 to +36
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The order of credentials differs from mise.local.example.toml. For consistency, consider reordering to match: CS_WORKSPACE_CRN, CS_CLIENT_ACCESS_KEY, (blank line), CS_DEFAULT_KEYSET_ID, CS_CLIENT_KEY, CS_CLIENT_ID. While the current order is functionally correct, matching the example file helps maintain consistency across documentation.

Suggested change
CS_CLIENT_KEY = ""
CS_CLIENT_ID = ""
CS_CLIENT_ACCESS_KEY = ""
CS_DEFAULT_KEYSET_ID = ""
CS_CLIENT_ACCESS_KEY = ""
CS_DEFAULT_KEYSET_ID = ""
CS_CLIENT_KEY = ""
CS_CLIENT_ID = ""

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@auxesis auxesis Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ordering in mise.local.example.toml is incorrect, so ignoring.

EOF

# In your browser:
# - Sign in to https://dashboard.cipherstash.com
# - Create or select a workspace
# - Generate and copy the credentials to your clipboard

# In your terminal:
# - Paste the credentials into mise.local.toml using your preferred text editor
nano mise.local.toml
Copy link
Contributor

@tobyhede tobyhede Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does everyone have a nano?

Copy link
Contributor Author

@auxesis auxesis Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it's on pretty much every Linux distribution, and on macOS.


# Build and run Proxy
mise run proxy
Expand Down