Signup and account management app for Kosmos Accounts https://accounts.kosmos.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Râu Cao 8f9e1c3e84
continuous-integration/drone/push Build is passing Details
Improve lnurlp message and notification
2 weeks ago
app Improve lnurlp message and notification 2 weeks ago
bin Add rspec binstub 12 months ago
config Merge pull request 'Various front-end improvements and bugfixes' (#78) from feature/frontend_improvements into master 2 weeks ago
db Add migration for unencrypted ln login field 4 weeks ago
docker Add Dockerfile for development 2 months ago
lib Add support and migration for lndhub.go 2 months ago
log Hello kosmos. 2 years ago
public Add empty state for wallet transactions view 4 weeks ago
spec Add specs for lndhub webhook 4 weeks ago
tmp Remove pid dir from git 2 months ago
vendor Hello kosmos. 2 years ago
.browserslistrc Hello kosmos. 2 years ago
.drone.yml Update Docker image in CI 2 months ago
.env.example WIP Add Webhooks controller, allowed IP config 4 weeks ago
.env.production WIP Add Webhooks controller, allowed IP config 4 weeks ago
.env.test WIP Add Webhooks controller, allowed IP config 4 weeks ago
.gitignore Switch from Webpacker to cssbundling-rails, upgrade Tailwind 12 months ago
.rspec Hello kosmos. 2 years ago
.ruby-version Upgrade to Rails 7, new JS build setup 12 months ago
Dockerfile Fix web container start when offline 4 weeks ago
Gemfile Add db/user seeds 2 months ago
Gemfile.lock Add db/user seeds 2 months ago
LICENSE Add AGPL license 2 years ago
Procfile.dev Add Docker Compose config and 389ds service 2 months ago
README.md Improve README, add quick start instructions 2 months ago
Rakefile Hello kosmos. 2 years ago
babel.config.js Hello kosmos. 2 years ago
config.ru Hello kosmos. 2 years ago
docker-compose.yml Don't start phpldapadmin by default 2 months ago
package.json Update dependencies 2 months ago
postcss.config.js Switch from Webpacker to cssbundling-rails, upgrade Tailwind 12 months ago
tailwind.config.js Improve notifications, fix styles not being added 12 months ago
yarn.lock Update dependencies 2 months ago

README.md

Build Status

Akkounts

This app allows Kosmos/LDAP users to manage their accounts, including credentials, invites, donations, etc..

Development

Quick Start

The easiest way to get a working development setup is using Docker Compose like so:

  1. Make sure Docker Compose is installed and Docker is running (included in Docker Desktop)
  2. Uncomment the web section in docker-compose.yml
  3. Run docker compose up and wait until 389ds announces its successful start in the log output
  4. docker-compose exec ldap dsconf localhost backend create --suffix="dc=kosmos,dc=org" --be-name="dev"
  5. docker compose run web rails ldap:setup
  6. docker compose run web rails db:setup

After these steps, you should have a working Rails app with a handful of test users running on http://localhost:3000.

Log in with username "admin" and password "admin is admin". All users listed on http://localhost:3000/admin/ldap_users have the password "user is user".

Rails app

Installing dependencies:

bundle install
yarn install

Setting up local database (SQLite):

bundle exec rails db:create
bundle exec rails db:migrate

Running the dev server and auto-building CSS files on change:

bin/dev

Running the background workers (requires Redis):

bundle exec sidekiq -C config/sidekiq.yml

Running all specs:

bundle exec rspec

Docker (Compose)

There is a working Docker Compose config file, which allows you to spin up both an app server for Rails as well as a local 389ds (LDAP) server.

By default, docker-compose up will only start the LDAP server, listening on port 389 on your machine. Uncomment other services in docker-compose.yml if you want to use them.

LDAP server

After creating the Docker container for the first time (or after deleting it), you need to run the following command once, in order to create the dirsrv back-end:

docker-compose exec ldap dsconf localhost backend create --suffix="dc=kosmos,dc=org" --be-name="dev"

Now you can seed the back-end with data using this Rails task:

bundle exec rails ldap:setup

The setup task will first delete any existing entries in the directory tree ("dc=kosmos,dc=org"), and then create our development entries.

Note that all 389ds data is stored in tmp/389ds. So if you want to start over with a fresh installation, delete both that directory as well as the container.

Documentation

Front-end

Testing

LDAP / Auth

Asynchronous jobs/workers

License

GNU Affero General Public License v3.0