{"id":51031035,"url":"https://github.com/dreamfactorysoftware/df-catalog","last_synced_at":"2026-06-22T00:30:57.112Z","repository":{"id":263043325,"uuid":"888752745","full_name":"dreamfactorysoftware/df-catalog","owner":"dreamfactorysoftware","description":null,"archived":false,"fork":false,"pushed_at":"2024-11-15T18:53:26.000Z","size":18,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-05T00:35:00.528Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dreamfactorysoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-15T00:13:11.000Z","updated_at":"2024-11-23T17:33:49.000Z","dependencies_parsed_at":"2024-11-15T19:45:42.403Z","dependency_job_id":null,"html_url":"https://github.com/dreamfactorysoftware/df-catalog","commit_stats":null,"previous_names":["dreamfactorysoftware/df-catalog"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dreamfactorysoftware/df-catalog","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-catalog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-catalog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-catalog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-catalog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dreamfactorysoftware","download_url":"https://codeload.github.com/dreamfactorysoftware/df-catalog/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dreamfactorysoftware%2Fdf-catalog/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34630753,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-21T02:00:05.568Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-22T00:30:56.638Z","updated_at":"2026-06-22T00:30:57.106Z","avatar_url":"https://github.com/dreamfactorysoftware.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DreamFactory Access Portal\n\nA Streamlit-based web application for managing access to DreamFactory APIs. This portal allows administrators to manage API access requests and users to request and view their API access.\n\n## Features\n\n- User registration and authentication\n- API access request system\n- Admin approval workflow\n- Automatic role and API key provisioning\n- Interactive API documentation with Swagger UI\n- Portal customization options\n\n## Prerequisites\n\n- Python 3.7+\n- DreamFactory instance with admin access\n- SQLite (included with Python)\n\n## Installation\n\n1. Clone the repository:\n```\ngit clone https://github.com/dreamfactorysoftware/df-streamlit.git\ncd df-streamlit\n```\n2. Install required packages:\n```\npip install -r requirements.txt\n```\n\n3. Create a `.streamlit/secrets.toml` file and add your DreamFactory URL and admin API key:\n```\ndreamfactory_url = \"your_dreamfactory_instance_url\"\nadmin_api_key = \"your_dreamfactory_admin_api_key\"\n```\n\n4. Run the application:\n```\nstreamlit run streamlit_app.py\n```\n\n## Initial Setup\n\n1. On first run, you'll be prompted to create a super admin account\n2. Log in with the created super admin credentials\n3. Use the admin panel to:\n   - Configure portal appearance\n   - Manage users and admins\n   - Handle API access requests\n\n## Usage\n\n### For Administrators\n- Approve or deny API access requests\n- Manage users and their permissions\n- Configure portal appearance\n- Monitor API usage\n- View users with access to each API\n- Revoke access when needed\n\n### For Users\n- Request access to available APIs\n- View granted API access details\n- Access interactive API documentation\n- Test API endpoints directly from the portal\n- View their API keys and endpoints\n- Preview data before requesting access\n\n## DreamFactory Configuration\n\n1. Obtain your DreamFactory instance URL (without http:// or https://)\n\n2. Get your admin API key:\n   - Log into DreamFactory admin console\n   - Go to System \u003e Roles \u003e Admin\n   - Copy the API Key\n\n3. Configure services in DreamFactory:\n   - Set up your database services\n   - Configure file storage services\n   - Set appropriate security settings\n\n## Security Notes\n\n- Store your `secrets.toml` securely and never commit it to version control\n- Use strong passwords for admin accounts\n- Regularly review API access permissions\n- Monitor the access logs in DreamFactory\n- Revoke access for inactive users\n- Keep your DreamFactory instance updated\n\n## Troubleshooting\n\nCommon issues and solutions:\n\n1. Connection Issues:\n   - Verify DreamFactory URL is correct (no http:// or https://)\n   - Check admin API key is valid\n   - Ensure DreamFactory instance is accessible\n\n2. Access Problems:\n   - Verify user permissions\n   - Check role configurations\n   - Review API key status\n\n3. Database Issues:\n   - Delete `dreamfactory_access.db` to reset the application\n   - Restart the application to recreate tables\n\n4. API Access Issues:\n   - Ensure services are properly configured in DreamFactory\n   - Check service permissions in DreamFactory\n   - Verify API keys are active\n\n## Development\n\nTo contribute to the development:\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Submit a pull request\n\nGuidelines:\n- Follow Python PEP 8 style guide\n- Add tests for new features\n- Update documentation as needed\n- Keep commits atomic and well-described\n\n## Contributing\n\nContributions are welcome! Please:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## License\n\nThis project is licensed under the Apache License 2.0 - see the LICENSE file for details.\n\n## Support\n\n- For portal issues: Create an issue in the GitHub repository\n- For DreamFactory questions: Visit [DreamFactory Forums](https://community.dreamfactory.com/)\n- For security concerns: Contact security@dreamfactory.com\n\n## Acknowledgments\n\n- DreamFactory team and community\n- Streamlit framework developers\n- All contributors to this project\n\n## Docker Installation\n\nYou can run the DreamFactory Access Portal using Docker:\n\n### Option 1: Using Docker Compose (Recommended)\n\n1. Create a `.streamlit/secrets.toml` file with your DreamFactory credentials:\n```toml\ndreamfactory_url = \"your_dreamfactory_instance_url\"\nadmin_api_key = \"your_dreamfactory_admin_api_key\"\n```\n\n2. Run with Docker Compose:\n```bash\ndocker-compose up --build\n```\n\n3. Access the portal at `http://localhost:8501`\n\n### Option 2: Using Docker Directly\n\n1. Build the Docker image:\n```bash\ndocker build -t dreamfactory-portal .\n```\n\n2. Run the container:\n```bash\ndocker run -p 8501:8501 -v ~/.streamlit:/app/.streamlit dreamfactory-portal\n```\n\n### Docker Configuration Notes\n\n- The application runs on port 8501 by default\n- The container uses a non-root user for security\n- The SQLite database persists in the container\n- Secrets are mounted from your local `.streamlit` directory\n- The container automatically pulls the latest code from GitHub during build\n\n### Troubleshooting Docker Setup\n\n1. Permission Issues:\n   - Ensure your `.streamlit` directory has proper permissions\n   - Check that secrets.toml is readable by the container\n\n2. Port Conflicts:\n   - If port 8501 is in use, modify the port mapping in docker-compose.yml\n   - Example: `\"8502:8501\"` to use port 8502 on the host\n\n3. Container Access:\n   - Use `docker logs dreamfactory-portal` to view application logs\n   - Use `docker exec -it dreamfactory-portal bash` to access the container shell\n\n4. Volume Mounts:\n   - Ensure your ~/.streamlit directory exists\n   - Check that secrets.toml is properly mounted\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamfactorysoftware%2Fdf-catalog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdreamfactorysoftware%2Fdf-catalog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdreamfactorysoftware%2Fdf-catalog/lists"}