mirror of
https://github.com/Infisical/infisical.git
synced 2026-01-05 05:34:17 -05:00
Update environment variables and documentation: set DB_CONNECTION_URI in .env.migration.example, remove FAQ section from contributing docs, and refine pull request guidelines.
This commit is contained in:
Victor Santos
@@ -1,2 +1,2 @@
|
||||
DB_CONNECTION_URI=
|
||||
DB_CONNECTION_URI=postgres://infisical:infisical@localhost:5432/infisical
|
||||
AUDIT_LOGS_DB_CONNECTION_URI=
|
||||
|
||||
4
.github/pull_request_template.md
vendored
4
.github/pull_request_template.md
vendored
@@ -20,6 +20,4 @@
|
||||
|
||||
---
|
||||
|
||||
- [ ] I have read the [contributing guide](https://infisical.com/docs/contributing/getting-started/overview), agreed and acknowledged the [code of conduct](https://infisical.com/docs/contributing/getting-started/code-of-conduct). 📝
|
||||
|
||||
<!-- If you have any questions regarding contribution, here's the FAQ : https://infisical.com/docs/contributing/getting-started/faq -->
|
||||
- [ ] I have read the [contributing guide](https://infisical.com/docs/contributing/getting-started/overview), agreed and acknowledged the [code of conduct](https://infisical.com/docs/contributing/getting-started/code-of-conduct). 📝
|
||||
@@ -1,93 +0,0 @@
|
||||
---
|
||||
title: "FAQ"
|
||||
description: "Frequently Asked Questions about contributing to Infisical"
|
||||
---
|
||||
|
||||
Frequently asked questions about contributing to Infisical can be found on this page.
|
||||
If you can't find the answer you are looking for, please create an issue on our GitHub repository or join our Slack channel for additional support.
|
||||
|
||||
<Accordion title="Error building Infisical platform backend (Alpine Linux CDN temporary error)">
|
||||
The Alpine Linux CDN may be unavailable/down in your region infrequently (eg. there is an unplanned outage). One possible fix is to add a retry mechanism and a fallback mirrors array to the Dockerfile. You can also use this as an opportunity to pin the Alpine Linux version for Docker to use in case there are issues with the latest version. Ensure to use https for the mirrors.
|
||||
|
||||
#### Make the following changes to the backend Dockerfile
|
||||
```bash
|
||||
# Pin Alpine version from list: https://dl-cdn.alpinelinux.org/alpine/
|
||||
ARG ALPINE_VERSION=3.17
|
||||
ARG ALPINE_APPEND=v3.17/main
|
||||
|
||||
# Specify number of retries for each mirror
|
||||
ARG MAX_RETRIES=3
|
||||
|
||||
# Define base Alpine mirror URLs in attempt order from list: https://dl-cdn.alpinelinux.org/alpine/MIRRORS.txt
|
||||
ARG BASE_ALPINE_MIRRORS="https://dl-cdn.alpinelinux.org/alpine https://ftp.halifax.rwth-aachen.de/alpine https://uk.alpinelinux.org/alpine"
|
||||
|
||||
# Build stage
|
||||
# Add the Alpine version arg
|
||||
FROM node:16-alpine$ALPINE_VERSION AS build
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
COPY package*.json ./
|
||||
RUN npm ci --only-production
|
||||
|
||||
COPY . .
|
||||
RUN npm run build
|
||||
|
||||
# Production stage
|
||||
# Add the Alpine version arg
|
||||
FROM node:16-alpine$ALPINE_VERSION
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
ENV npm_config_cache /home/node/.npm
|
||||
|
||||
COPY package*.json ./
|
||||
RUN npm ci --only-production
|
||||
|
||||
COPY --from=build /app .
|
||||
|
||||
# Add retry mechanism and loop through the specified mirrors
|
||||
RUN retries_left=$MAX_RETRIES; \
|
||||
for mirror in $ALPINE_MIRRORS; do \
|
||||
full_mirror="$mirror/$ALPINE_APPEND"; \
|
||||
echo "Trying mirror: $full_mirror"; \
|
||||
echo >>/etc/apk/repositories "$full_mirror"; \
|
||||
for i in $(seq $retries_left); do \
|
||||
echo "Retrying... Attempt $i (Retries Left: $((retries_left - i)))"; \
|
||||
if apk add --no-cache bash curl git && \
|
||||
curl -1sLf 'https://dl.cloudsmith.io/public/infisical/infisical-cli/setup.alpine.sh' | bash && \
|
||||
apk add --no-cache infisical=0.8.1; then \
|
||||
break; \
|
||||
fi; \
|
||||
sleep 10; \
|
||||
done; \
|
||||
if [ $? -eq 0 ]; then \
|
||||
break; \
|
||||
fi; \
|
||||
done
|
||||
|
||||
HEALTHCHECK --interval=10s --timeout=3s --start-period=10s \
|
||||
CMD node healthcheck.js
|
||||
|
||||
EXPOSE 4000
|
||||
|
||||
CMD ["npm", "run", "start"]
|
||||
```
|
||||
|
||||
<Info>
|
||||
[Alpine Linux (mirrors) - official site](https://dl-cdn.alpinelinux.org/alpine/MIRRORS.txt)
|
||||
</Info>
|
||||
|
||||
<Info>
|
||||
[Alpine Linux (mirrors) - archived site](https://web.archive.org/web/20230914123159/https://dl-cdn.alpinelinux.org/alpine/MIRRORS.txt)
|
||||
</Info>
|
||||
|
||||
<Info>
|
||||
[Alpine Linux (versions) - official site](https://dl-cdn.alpinelinux.org/alpine/)
|
||||
</Info>
|
||||
|
||||
<Info>
|
||||
[Alpine Linux (versions) - archived site](https://web.archive.org/web/20230914123455/https://dl-cdn.alpinelinux.org/alpine/)
|
||||
</Info>
|
||||
|
||||
</Accordion>
|
||||
@@ -20,7 +20,6 @@ Infisical has two major code-bases. One for the platform code, and one for SDKs.
|
||||
- [C++ SDK](https://github.com/Infisical/infisical-cpp-sdk)
|
||||
- [PHP SDK](https://github.com/Infisical/php-sdk)
|
||||
- [Rust SDK](https://github.com/Infisical/rust-sdk)
|
||||
- [Ruby SDK](https://github.com/infisical/sdk)
|
||||
|
||||
## Community
|
||||
|
||||
|
||||
@@ -29,13 +29,7 @@ Feel free to add a short video or screenshots of what your PR achieves.
|
||||
|
||||
## Getting your PR reviewed
|
||||
|
||||
Once your PR is reviewed, one or two relevant members of the Infisical team should review and approve the PR before it is merged. You should coordinate and ping the team member closest to the submitted functionality via our [Slack](https://infisical.com/slack) to review your PR.
|
||||
|
||||
- Vlad: Frontend, Web UI
|
||||
- Tony: Backend, SDKs, Security
|
||||
- Maidul: Backend, CI/CD, CLI, Kubernetes Operator
|
||||
- Daniel: Frontend, UI/UX, Backend, SDKs
|
||||
|
||||
One or two relevant members of the Infisical team should review and approve the PR before it is merged. You can ping someone from the team in our [Slack](https://infisical.com/slack) to review your PR.
|
||||
|
||||
The team member(s) will start by enabling baseline checks to ensure that there are no leaked secrets, new dependencies are clear, and the frontend/backend services start up. Afterward, they will review your PR thoroughly by testing the code and leave any feedback or work in with you to revise the PR up to standard.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ Suppose you're interested in implementing a new feature in Infisical's backend,
|
||||
If your feature involves a change in the database, you need to first address this by generating the necessary database schemas.
|
||||
|
||||
1. If you're adding a new table, update the `TableName` enum in `/src/db/schemas/models.ts` to include the new table name.
|
||||
2. Create a new migration file by running `npm run migration:new` and give it a relevant name, such as `feature-x`.
|
||||
2. Create a new migration file by going to the `/backend` folder and running `npm run migration:new` and give it a relevant name, such as `feature-x`.
|
||||
3. Navigate to `/src/db/migrations/<timestamp>_<feature-x>.ts`.
|
||||
4. Modify both the `up` and `down` functions to create or alter Postgres fields on migration up and to revert these changes on migration down, ensuring idempotency as outlined [here](https://github.com/graphile/migrate/blob/main/docs/idempotent-examples.md).
|
||||
|
||||
@@ -16,10 +16,11 @@ If your feature involves a change in the database, you need to first address thi
|
||||
|
||||
While typically you would need to manually write TS types for Knex type-sense, we have automated this process:
|
||||
|
||||
1. Start the server.
|
||||
2. Run `npm run migration:latest` to apply all database changes.
|
||||
3. Execute `npm run generate:schema` to automatically generate types and schemas using [zod](https://github.com/colinhacks/zod) in the `/src/db/schemas` folder.
|
||||
4. Update the barrel export in `schema/index` and include the new tables in `/src/@types/knex.d.ts` to enable type-sensing in Knex.js.
|
||||
1. If you haven't done it yet, create a new `.env.migration` file at the root of the Infisical directory then copy the contents of the file linked [here](https://github.com/Infisical/infisical/blob/main/.env.migration.example)
|
||||
2. Start the server.
|
||||
3. Go to the `/backend` folder and run `npm run migration:latest-dev` to apply all database changes.
|
||||
4. Execute `npm run generate:schema` to automatically generate types and schemas using [zod](https://github.com/colinhacks/zod) in the `/src/db/schemas` folder.
|
||||
5. Update the barrel export in `schema/index` and include the new tables in `/src/@types/knex.d.ts` to enable type-sensing in Knex.js.
|
||||
|
||||
## Business Logic
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ git checkout -b MY_BRANCH_NAME
|
||||
|
||||
## Set up environment variables
|
||||
|
||||
Start by creating a .env file at the root of the Infisical directory then copy the contents of the file linked [here](https://github.com/Infisical/infisical/blob/main/.env.example). View all available [environment variables](https://infisical.com/docs/self-hosting/configuration/envars) and guidance for each.
|
||||
Start by creating a `.env` file at the root of the Infisical directory then copy the contents of the file linked [here](https://github.com/Infisical/infisical/blob/main/.env.example). View all available [environment variables](https://infisical.com/docs/self-hosting/configuration/envars) and guidance for each.
|
||||
|
||||
## Starting Infisical for development
|
||||
|
||||
|
||||
@@ -377,8 +377,7 @@
|
||||
"pages": [
|
||||
"contributing/getting-started/overview",
|
||||
"contributing/getting-started/code-of-conduct",
|
||||
"contributing/getting-started/pull-requests",
|
||||
"contributing/getting-started/faq"
|
||||
"contributing/getting-started/pull-requests"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user