Browse Source

docs and logos (#7)

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

* update dockerignore
Milo Schwartz 6 months ago
parent
commit
a36691e5ab

+ 0 - 1
.dockerignore

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

+ 1 - 1
.gitignore

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

+ 8 - 2
CONTRIBUTING.md

@@ -1,6 +1,12 @@
 ## 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
 
@@ -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
 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.
-```
+```

+ 1 - 1
Dockerfile

@@ -26,7 +26,7 @@ COPY --from=builder /app/.next ./.next
 COPY --from=builder /app/dist ./dist
 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 public ./public

+ 0 - 0
config/.gitkeep


+ 6 - 17
config.example.yml → config/config.example.yml

@@ -1,13 +1,13 @@
 app:
-    base_url: https://proxy.example.com
-    log_level: info
+    base_url: http://localhost
+    log_level: debug
     save_logs: false
 
 server:
     external_port: 3000
     internal_port: 3001
     next_port: 3002
-    internal_hostname: pangolin
+    internal_hostname: localhost
     secure_cookies: false
     session_cookie_name: p_session
     resource_session_cookie_name: p_resource_session
@@ -16,34 +16,23 @@ traefik:
     cert_resolver: letsencrypt
     http_entrypoint: web
     https_entrypoint: websecure
-    prefer_wildcard_cert: true
 
 gerbil:
     start_port: 51820
-    base_endpoint: proxy.example.com
-    use_subdomain: false
+    base_endpoint: localhost
     block_size: 16
     subnet_group: 10.0.0.0/8
+    use_subdomain: true
 
 rate_limits:
     global:
         window_minutes: 1
         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:
     server_admin:
         email: admin@example.com
         password: Password123!
 
 flags:
-    require_email_verification: true
-    disable_signup_without_invite: true
-    disable_user_create_org: true
-
+    require_email_verification: false

+ 0 - 0
config/db/.gitkeep


+ 0 - 0
config/logs/.gitkeep


BIN
public/logo/pangolin_orange_192x192.png


BIN
public/logo/pangolin_orange_512x512.png


BIN
public/logo/pangolin_orange_96x96.png