{"_id":"@akeyless-community/railway-runtime","name":"@akeyless-community/railway-runtime","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@akeyless-community/railway-runtime","version":"0.1.0","description":"Fetch Akeyless secrets at runtime on Railway (Node.js) — no env-var sync required","license":"Apache-2.0","author":{"name":"Akeyless Community"},"repository":{"type":"git","url":"git+https://github.com/akeyless-community/railway-akeyless-runtime.git"},"homepage":"https://github.com/akeyless-community/railway-akeyless-runtime#readme","keywords":["akeyless","railway","secrets","runtime","environment-variables","paas"],"engines":{"node":">=18"},"main":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","default":"./dist/index.js"}},"scripts":{"build":"tsc -p tsconfig.json","test":"node --experimental-vm-modules node_modules/jest/bin/jest.js","prepublishOnly":"npm run build","example:install":"npm run build && cd examples/express && npm install","example:start":"npm run example:install && cd examples/express && npm start"},"publishConfig":{"access":"public"},"dependencies":{"akeyless":"^5.0.25","akeyless-cloud-id":"^1.0.0"},"devDependencies":{"@types/jest":"^29.5.14","@types/node":"^20.17.0","jest":"^29.7.0","ts-jest":"^29.2.5","typescript":"^5.7.2"},"_id":"@akeyless-community/railway-runtime@0.1.0","bugs":{"url":"https://github.com/akeyless-community/railway-akeyless-runtime/issues"},"_nodeVersion":"26.3.0","_npmVersion":"11.16.0","dist":{"integrity":"sha512-JFzYWymYBleYN1ZpDJ0TY1kUvGxQCaRsVnSfZ9RtaTxahvAYMQtrMudl4Z28L9LIp0ou8biHMUpyENb6y8T5mQ==","shasum":"a3e33ca85d0997b42288613561748b70ff786231","tarball":"https://registry.npmjs.org/@akeyless-community/railway-runtime/-/railway-runtime-0.1.0.tgz","fileCount":31,"unpackedSize":71015,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQCTDGDAaq5daNz8jbsVSbLAg3HkDMjEhNnJfpPi52hszwIhAKn+WqYeeOnOhAJ+vXqnoPMGEaCAaQqh6pusxkoo5btf"}]},"_npmUser":{"name":"barak-akeyless","email":"barak.a@akeyless.io"},"directories":{},"maintainers":[{"name":"barak-akeyless","email":"barak.a@akeyless.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/railway-runtime_0.1.0_1781504857046_0.23633619656836058"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-15T06:27:36.889Z","0.1.0":"2026-06-15T06:27:37.189Z","modified":"2026-06-15T06:27:37.425Z"},"maintainers":[{"name":"barak-akeyless","email":"barak.a@akeyless.io"}],"description":"Fetch Akeyless secrets at runtime on Railway (Node.js) — no env-var sync required","homepage":"https://github.com/akeyless-community/railway-akeyless-runtime#readme","keywords":["akeyless","railway","secrets","runtime","environment-variables","paas"],"repository":{"type":"git","url":"git+https://github.com/akeyless-community/railway-akeyless-runtime.git"},"author":{"name":"Akeyless Community"},"bugs":{"url":"https://github.com/akeyless-community/railway-akeyless-runtime/issues"},"license":"Apache-2.0","readme":"# @akeyless-community/railway-runtime\n\nFetch [Akeyless](https://www.akeyless.io) secrets at **runtime** on [Railway](https://railway.com) (Node.js). Application secrets stay in Akeyless — only bootstrap auth variables are stored on Railway.\n\n**Repository:** [github.com/akeyless-community/railway-akeyless-runtime](https://github.com/akeyless-community/railway-akeyless-runtime)\n\n## Install\n\n```bash\nnpm install @akeyless-community/railway-runtime\n```\n\nRequires **Node.js 18+**.\n\n## Quick start\n\n### 1. Set bootstrap variables on Railway\n\nIn your Railway service **Variables** tab, add read-only Akeyless credentials:\n\n| Variable | Required | Example |\n|----------|----------|---------|\n| `AKEYLESS_ACCESS_ID` | Yes* | `p-xxxxx` |\n| `AKEYLESS_ACCESS_KEY` | Yes* | access key secret |\n| `AKEYLESS_SECRET_PREFIX` | Recommended | `/railway/my-project/production` |\n| `AKEYLESS_GATEWAY_URL` | No | `https://api.akeyless.io` |\n\n\\* Or use another [auth method](#authentication) below.\n\nIf `AKEYLESS_SECRET_PREFIX` is omitted, the library derives it from Railway metadata:\n\n```\n/railway/{RAILWAY_PROJECT_NAME}/{RAILWAY_ENVIRONMENT_NAME}\n```\n\nRailway sets `RAILWAY_PROJECT_NAME`, `RAILWAY_ENVIRONMENT_NAME`, and `RAILWAY_SERVICE_NAME` automatically on every deployment. See the [Railway variables reference](https://docs.railway.com/variables/reference).\n\n### 2. Store application secrets in Akeyless\n\n```\n/railway/my-project/production/DATABASE_URL\n/railway/my-project/production/STRIPE_SECRET_KEY\n```\n\nFor multi-service projects, either use a shared project/environment prefix or opt into per-service prefixes:\n\n```bash\nAKEYLESS_INCLUDE_SERVICE_IN_PREFIX=true\n# → /railway/my-project/production/api-service/DATABASE_URL\n```\n\n### 3. Fetch secrets in your app\n\n```javascript\nconst express = require('express');\nconst { getSecret } = require('@akeyless-community/railway-runtime');\n\nconst app = express();\n\napp.get('/health', async (_req, res) => {\n  const dbUrl = await getSecret('DATABASE_URL');\n  res.json({ ok: true, hasDb: Boolean(dbUrl) });\n});\n\napp.listen(process.env.PORT || 3000);\n```\n\nUse `getSecret` only in **server** code. Never expose fetched secrets to the browser.\n\n## Per-environment prefixes\n\n| Railway environment | Typical prefix |\n|---------------------|----------------|\n| production | `/railway/my-project/production` |\n| staging | `/railway/my-project/staging` |\n| development | `/railway/my-project/development` |\n\nSet `AKEYLESS_SECRET_PREFIX` explicitly when you need a custom layout.\n\n## API\n\n### Convenience (singleton, replica-friendly)\n\n```javascript\nconst { getSecret, getDefaultClient } = require('@akeyless-community/railway-runtime');\n\nconst dbUrl = await getSecret('DATABASE_URL');\n```\n\n### Explicit client\n\n```javascript\nconst { createClient } = require('@akeyless-community/railway-runtime');\n\nconst client = createClient({\n  gatewayUrl: 'https://api.akeyless.io',\n  secretPrefix: '/railway/my-project/production',\n  accessId: process.env.AKEYLESS_ACCESS_ID,\n  accessKey: process.env.AKEYLESS_ACCESS_KEY,\n});\n\nawait client.getSecret('DATABASE_URL');\nawait client.getSecretAtPath('/custom/full/path');\nawait client.getDynamicSecret('db-creds');\nawait client.getRotatedSecret('rotated-api-key');\n```\n\n## Authentication\n\nConfigure via Railway service variables or `createClient({ ... })`.\n\n| Method | `AKEYLESS_ACCESS_TYPE` | Additional variables |\n|--------|------------------------|----------------------|\n| Access key (default) | `access_key` | `AKEYLESS_ACCESS_ID`, `AKEYLESS_ACCESS_KEY` |\n| API key | `api_key` | `AKEYLESS_ACCESS_ID`, `AKEYLESS_ACCESS_KEY` |\n| Universal Identity | `universal_identity` | `AKEYLESS_UID_TOKEN` |\n| JWT | `jwt` | `AKEYLESS_ACCESS_ID`, `AKEYLESS_JWT` |\n| AWS IAM | `aws_iam` | `AKEYLESS_ACCESS_ID`, optional `AKEYLESS_CLOUD_ID` |\n| Pre-authenticated | — | `AKEYLESS_TOKEN` |\n\nUse a dedicated Akeyless auth method with **read-only** access to your `/railway/...` path.\n\n## Local development with Railway CLI\n\nRun your app locally with the same variables as your Railway project:\n\n```bash\nrailway link\nrailway run npm start\n```\n\nOr export variables manually:\n\n```bash\nexport AKEYLESS_ACCESS_ID=p-xxxxx\nexport AKEYLESS_ACCESS_KEY=your-key\nexport AKEYLESS_SECRET_PREFIX=/railway/my-project/development\nexport RAILWAY_PROJECT_NAME=my-project\nexport RAILWAY_ENVIRONMENT_NAME=development\n```\n\n## Caching\n\n- **Auth tokens** refresh before expiry (default margin: 1 minute).\n- **Secret values** cache in memory for **5 minutes** by default (`AKEYLESS_SECRET_CACHE_TTL_MS`).\n- Long-lived Railway replicas reuse the module singleton.\n\nLower TTL or use `ignoreCache: true` for frequently rotated secrets.\n\n## Push sync vs runtime pull\n\n| Pattern | When to use |\n|---------|-------------|\n| **Runtime pull** (this package) | Akeyless stays source of truth; only bootstrap creds on Railway |\n| **Push sync** | Copy secrets into Railway variables (future Akeyless Destination Sync or CI) |\n\nRuntime pull works today without any Railway partnership or marketplace listing.\n\n## Example app\n\n```bash\nnpm run build\ncd examples/express && npm install\nnpm start\n```\n\nSet `AKEYLESS_*` env vars (or use `railway run`) before starting.\n\n## Publishing\n\nThis package is Apache-2.0 and published as `@akeyless-community/railway-runtime` on npm.\n\nTo publish from a standalone clone:\n\n```bash\nnpm ci\nnpm test\nnpm publish --access public\n```\n\n## Related community projects\n\n- [@akeyless-community/vercel-runtime](../vercel-akeyless-runtime) — Vercel runtime secrets\n- [@akeyless-community/netlify-runtime](../netlify-akeyless-runtime) — Netlify runtime secrets\n- [@akeyless-community/heroku-runtime](../heroku-akeyless-runtime) — Heroku runtime secrets\n- [buildkite-akeyless-plugin](../buildkite-akeyless-plugin) — CI secret injection\n\n## License\n\nApache-2.0\n","readmeFilename":"README.md","_rev":"1-4e03f3e1b5a180580c1b6f7903bb0891"}