{"id":19648282,"url":"https://github.com/bestpractical/rtfm","last_synced_at":"2025-07-23T11:06:16.578Z","repository":{"id":608423,"uuid":"245622","full_name":"bestpractical/rtfm","owner":"bestpractical","description":null,"archived":false,"fork":false,"pushed_at":"2013-02-12T23:43:24.000Z","size":1799,"stargazers_count":8,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-06T18:07:50.228Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://search.cpan.org/dist/rtfm","language":"Perl","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"GoogleCloudPlatform/go-endpoints","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bestpractical.png","metadata":{"files":{"readme":"README","changelog":"Changelog","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2009-07-07T21:31:00.000Z","updated_at":"2014-09-08T20:20:04.000Z","dependencies_parsed_at":"2022-07-05T03:01:55.301Z","dependency_job_id":null,"html_url":"https://github.com/bestpractical/rtfm","commit_stats":null,"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"purl":"pkg:github/bestpractical/rtfm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bestpractical%2Frtfm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bestpractical%2Frtfm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bestpractical%2Frtfm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bestpractical%2Frtfm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bestpractical","download_url":"https://codeload.github.com/bestpractical/rtfm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bestpractical%2Frtfm/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266665813,"owners_count":23964974,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":"2024-11-11T14:47:39.485Z","updated_at":"2025-07-23T11:06:16.556Z","avatar_url":"https://github.com/bestpractical.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"RTFM (The RT FAQ Manager) is a tool for maintaining an organizational\nknowledgebase. Out of the box, it integrates with RT 3.4.2 or later\n(Also available from bestpractical.com)\n\nBest Practical sells support and customization for RT and RTFM.  Feel\nfree to contact us at sales@bestpractical.com if you have any\nquestions about our service offerings.\n\nRTFM requires a few modules in addition to RT's standard dependencies.\nThe 'perl Makefile.PL' command will check that you have all of the\nrequired modules installed; if not, they will either be auto-installed\nduring the 'make' step, or you can opt to install them by hand using\nthe CPAN shell or with any system-specific package management software\nyou may have.\n\nInstallation instructions:\n--------------------------\n\nNOTE that upgrade steps are described in UPGRADING\n\n1) Install RT 3.4.2 or newer.\n   Do not use this with 3.8.0 as there are incompatibilities.\n   Any other release of RT 3.8 is fine.\n\n2) Once RT appears to be happily installed, cd into the directory\n   where you unpacked RTFM.\n\n3) perl Makefile.PL\n\n4) make install\n\n5) make initdb\n\n6) If you are running 3.8, you need to enable RTFM in your \n   RT_SiteConfig.pm file.  You can do this by adding the following\n   line:\n\n   Set(@Plugins,qw(RT::FM));\n\n   If you already have a @Plugins line, you must add RT::FM to your\n   existing plugin list.\n\n7) Clear your mason cache.  This is most often accomplished with\n   rm -rf /opt/rt3/var/mason_data/*\n\n8) Stop and start your web server\n\n9) Before you can add content to RTFM articles, you will need to configure\n   classes and custom fields. For details, see lib/RT/FM/Introduction.pod\n\nFurther reading:\n-----------------------------------------------------\n\nlib/RT/FM/Introduction.pod - quick overview and configuration\n\nYou can read this using the perldoc utility, viewing the\nsource or using the RT-OnlineDocs extension\n\nDevelopment\n------------------------------------------------------\n\nIf you would like to run RTFM's tests, you need to\nset a few environment variables\nRT_DBA_USER - a user who can create a database on your \n              RDBMS (such as root on mysql)\nRT_DBA_PASSWORD - the password for RT_DBA_USER\nPERL5LIB - the path to your RT libraries (/opt/rt3/lib)\n\nRT_DBA_USER=user RT_DBA_PASSWORD=password PERL5LIB=/opt/rt3/lib make test\n\nThese are intended to be run before installing RTFM.\nLike RT, RTFM expects to be able to create a new database called rt3test\non your system.\n\nBug reporting and discussion lists:\n-----------------------------------------------------\n\nYou probably want to discuss RTFM on rt-users@lists.bestpractical.com.\n(Send mail to rt-users-request@lists.fsck.com to subscribe)\n\nBug reports can be sent to rtfm-bugs@bestpractical.com. You can look\nat open bug reports at http://rt3.fsck.com/. Log in as guest/guest\nto see the content of bug reports.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbestpractical%2Frtfm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbestpractical%2Frtfm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbestpractical%2Frtfm/lists"}