Skip to content

Latest commit

 

History

History
155 lines (119 loc) · 7.01 KB

README.md

File metadata and controls

155 lines (119 loc) · 7.01 KB
Raw

DanWolf.NET

Install

git clone github.com/PaluMacil/dwn
go build

Configuration

The settings table below shows the environmental variables to override defaults. The default sometimes varies between prod and dev. In prod mode, you must set and encryption key and cannot use the default dev key.

Core Settings

setting env prod dev
protocol DWN_PROTOCOL https http
host DWN_HOST danwolf.net localhost
port (api/server) DWN_PORT 3035 3035
ui port DWN_UI_PROXY_PORT 443 4200
content root (ui) DWN_CONTENT_ROOT /opt/dwn/ui /home/dan/repos/dwn-ui/dist
initial admin DWN_INITIAL_ADMIN (none configured) [email protected]
initial password DWN_INITIAL_PASSWORD (none configured) (none configured)
data directory DWN_DATA_DIR data data
master encryption key DWN_MASTER_ENC_KEY (must configure!) 3d17618d4297f83665b32e28f9b1c23d
use FileIO / small RAM DWN_DATA_FILE_IO false false
specify 404 handler DWN_STATUS_404_HANDLER DEFAULT DETAILED

Note that if you are developing on Windows, encryption is disabled (along with memory-mapped files since Windows uses disk IO instead of memory mapped files). You will also need to set your own content root if you are using Windows or your username isn't dan.

The initial admin is used for recognizing a user that should be marked as verified and added to the admin usergroup upon user registration. This user will not have a default password, so setting up an auth provider foreign system such as Google will also be required unless you also set an initial password. Once this user logs in, this environmental variable should be removed. The initial password is an option if you don't want to use an auth provider for the initial admin. This will be hashed as soon as the user is created, and at that point you should remove the variable and restart the server. If created from the registration form instead of the oauth flow, be sure to register with a password matching the configured initial password or the user will not be added to the admin group.

The ui port is used for building URLs for things like OAuth2 redirects. This is the port which will be used to access the website. The port setting, on the other hand, represents the port the server application is listening to. On a server without a proxy in front of its web applications, these values might be the same. At this time, however, the application depends upon a server like Caddy or Nginx to serve TLS. While running in dev mode, you will probably be running ng serve to serve the UI from port 4200, and the angular application will proxy backend requests to port 3035.

Foreign Systems

Foreign systems include authentication providers, SMTP providers, and other APIs. For foreign systems that can be configured by environmental variable, doing so will lock those settings in the UI, preventing live modification of settings. Most foreign systems require a key and secret or at least a token. These details should be kept in a password manager or other type of secure system.

Authentication Providers

setting env
Google OAuth2 Key DWN_OAUTH_GOOGLE_KEY
Google OAuth2 Secret DWN_OAUTH_GOOGLE_SECRET
External Provider Configuration

Other Foreign Systems

setting env
Sendgrid SMTP Key DWN_SMTP_SENDGRID_KEY
Sendgrid SMTP Secret DWN_SMTP_SENDGRID_SECRET
External System Configuration

Run

For development defaults, leave off the prod subcommand:

.\dwn prod

To run the UI (dev mode only--prod mode serves its own files), use the command ng serve which depends upon Node and the Angular CLI.

Docker

Build

docker build -t dwn-server .

Also, build dwn-ui with ng build and populate a SECRETS.txt. If you instead want to copy locally built files, you can use scp with scp -r dist p3:/home/pi/dwn-ui/dist. This might be necessary in low RAM environments.

SECRETS.txt

Use a SECRETS.txt file to pass environmental variables to Docker. Separate keys and values with an = and do not enclose values in quotes like you might do ion other configuration systems.

Run

You can run the image with the following command. The --add-host flag adds a custom host-to-IP mapping. This means you can access localhost of the Docker host as if it was the localhost of the image. This simplifies local testing where every service is likely to be running on the same machine.

docker run -d \
 --restart unless-stopped \
 -p 3035:3035 \
 --name dwn \
 --add-host=host.docker.internal:host-gateway \
 --env-file SECRETS.txt \
 -v /home/pi/dwn-ui/dist/dwn-ui:/opt/dwn/ui/dwn-ui \
 dwn-server

Low RAM / Raspberry Pi

DWN_DATA_FILE_IO might need to be set to true on a Raspberry Pi due to memory map issues in badger. This is not available in badger version 3.

Licensing

The license for this project is MIT but some dependencies might have Apache or similar licenses. General reuse isn't necessarily intended and APIs might break, but it is permissible.

Roadmap

Section Priorities

  • game
  • file
  • visit
  • (then comment docs, tests, and README)
  • download
  • photo
  • blog
  • backup
  • landlord

Unsorted Thoughts

  • Friends linked to friend role if appearing in Facebook friends
  • Movie list: people in friends role should be able to vote for movies they want to see (to plan movie parties)
  • Admins should be able to do some things on behalf of others (mark that someone wants to see a movie even if they don't have an account)
  • photo album
  • blog
  • downloads

Improve:

  • get from env config: TokenName: "dwn-token"
  • Make sure certain keys (e.g. email) are not case-sensitive
  • document use of environmental variables
  • when routing, first trim off base url (if base url isn't '/', then currently routing will be misaligned when split and break)