An unofficial, mostly Bitwarden-compatible API server written in Ruby (Sinatra and ActiveRecord)
README: document changing URL paths
+23
+23
README.md
+23
README.md
···
73
73
74
74
bundle exec rake test
75
75
76
+
### Changing URL Paths
77
+
78
+
By default, Rubywarden is setup to use paths on a single hostname that the
79
+
Bitwarden clients will default to so you do not have to specify separate API,
80
+
Identity, and Icon URLs.
81
+
82
+
If you are not deploying Rubywarden on its own hostname or want to alter the
83
+
paths for any reason, you can override them with environment variables:
84
+
85
+
- `RUBYWARDEN_BASE_URL` for the API base - defaults to `/api`
86
+
- `RUBYWARDEN_IDENTITY_BASE_URL` for the identity API base - defaults to
87
+
`/identity`
88
+
- `RUBYWARDEN_ICONS_URL` for the icon URL - defaults to `/icons`
89
+
90
+
For example, if you had a website `example.com` and wanted to host Rubywarden
91
+
on a subdirectory called `/notbitwarden`, you would set the environment
92
+
variables in your startup script:
93
+
94
+
sudo -u _rubywarden env RUBYWARDEN_ENV=production RUBYWARDEN_BASE_URL=/notbitwarden/api RUBYWARDEN_IDENTITY_BASE_URL=/notbitwarden/identity RUBYWARDEN_ICONS_URL=/notbitwarden/icons bundle exec rackup -p 4567 config.ru
95
+
96
+
Then you can configure the Bitwarden clients with a single server URL of
97
+
`https://example.com/notbitwarden`.
98
+
76
99
### Updating
77
100
78
101
If you've previously used Rubywarden before July 30, 2018 when it was called