docs and logos (#7)

* add example config dir, logos, and update CONTRIBUTING.md

* update dockerignore
This commit is contained in:
Milo Schwartz 2025-01-06 22:43:17 -05:00 committed by GitHub
parent b1d111a089
commit a36691e5ab
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 16 additions and 22 deletions

View file

@ -23,7 +23,6 @@ next-env.d.ts
.machinelogs*.json .machinelogs*.json
*-audit.json *-audit.json
package-lock.json package-lock.json
config/
install/ install/
bruno/ bruno/
LICENSE LICENSE

2
.gitignore vendored
View file

@ -25,7 +25,7 @@ next-env.d.ts
migrations migrations
package-lock.json package-lock.json
tsconfig.tsbuildinfo tsconfig.tsbuildinfo
config/ config/config.yml
dist dist
.dist .dist
installer installer

View file

@ -1,6 +1,12 @@
## Contributing ## Contributing
Contributions are welcome! Please see the following page in our documentation with future plans and feature ideas if you are looking for a place to start. Contributions are welcome!
Please see the contribution and local development guide on the docs page before getting started:
https://docs.fossorial.io/development
For ideas about what features to work on and our future plans, please see the roadmap:
https://docs.fossorial.io/roadmap https://docs.fossorial.io/roadmap
@ -15,4 +21,4 @@ By creating this pull request, I grant the project maintainers an unlimited,
perpetual license to use, modify, and redistribute these contributions under any terms they perpetual license to use, modify, and redistribute these contributions under any terms they
choose, including both the AGPLv3 and the Fossorial Commercial license terms. I choose, including both the AGPLv3 and the Fossorial Commercial license terms. I
represent that I have the right to grant this license for all contributed content. represent that I have the right to grant this license for all contributed content.
``` ```

View file

@ -26,7 +26,7 @@ COPY --from=builder /app/.next ./.next
COPY --from=builder /app/dist ./dist COPY --from=builder /app/dist ./dist
COPY --from=builder /app/init ./dist/init COPY --from=builder /app/init ./dist/init
COPY config.example.yml ./dist/config.example.yml COPY config/config.example.yml ./dist/config.example.yml
COPY server/db/names.json ./dist/names.json COPY server/db/names.json ./dist/names.json
COPY public ./public COPY public ./public

0
config/.gitkeep Normal file
View file

View file

@ -1,13 +1,13 @@
app: app:
base_url: https://proxy.example.com base_url: http://localhost
log_level: info log_level: debug
save_logs: false save_logs: false
server: server:
external_port: 3000 external_port: 3000
internal_port: 3001 internal_port: 3001
next_port: 3002 next_port: 3002
internal_hostname: pangolin internal_hostname: localhost
secure_cookies: false secure_cookies: false
session_cookie_name: p_session session_cookie_name: p_session
resource_session_cookie_name: p_resource_session resource_session_cookie_name: p_resource_session
@ -16,34 +16,23 @@ traefik:
cert_resolver: letsencrypt cert_resolver: letsencrypt
http_entrypoint: web http_entrypoint: web
https_entrypoint: websecure https_entrypoint: websecure
prefer_wildcard_cert: true
gerbil: gerbil:
start_port: 51820 start_port: 51820
base_endpoint: proxy.example.com base_endpoint: localhost
use_subdomain: false
block_size: 16 block_size: 16
subnet_group: 10.0.0.0/8 subnet_group: 10.0.0.0/8
use_subdomain: true
rate_limits: rate_limits:
global: global:
window_minutes: 1 window_minutes: 1
max_requests: 100 max_requests: 100
email:
smtp_host: host.hoster.net
smtp_port: 587
smtp_user: no-reply@example.com
smtp_pass: aaaaaaaaaaaaaaaaaa
no_reply: no-reply@example.com
users: users:
server_admin: server_admin:
email: admin@example.com email: admin@example.com
password: Password123! password: Password123!
flags: flags:
require_email_verification: true require_email_verification: false
disable_signup_without_invite: true
disable_user_create_org: true

0
config/db/.gitkeep Normal file
View file

0
config/logs/.gitkeep Normal file
View file

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB