sentry icon indicating copy to clipboard operation
sentry copied to clipboard

Good README needed

Open KrzysztofMadejski opened this issue 8 years ago • 7 comments

  • Overview
  • Features
  • Installation
  • Troubleshooting

KrzysztofMadejski avatar Jun 09 '17 13:06 KrzysztofMadejski

Installation

Docker installation

docker compose up

Manual installation

  1. Install Go language
  2. Download and build repository
    export GOPATH=$(go env GOPATH)
    mkdir -pv $GOPATH
    cd $GOPATH
    
    git clone https://github.com/archivers-space/sentry
    cd sentry
    go install
    
  3. Configure Postgres server and then set connection URL
    export POSTGRES_DB_URL=postgres://[USERNAME_HERE]:[PASSWORD_HERE]@localhost:[PORT]/[DB_NAME]
    
  4. Run sentry
    $GOPATH/bin/sentry
    

How to configure S3 buckets?

  • on production
  • @b5 how do you work with them in development env?

KrzysztofMadejski avatar Jun 09 '17 14:06 KrzysztofMadejski

@KrzysztofMadejski do you want to submit a quick PR now with some of this? We start sprinting in 2 hours and maybe @b5 and I cna jump on the branch you create. This is what we want the sprint to accomplish!!

titaniumbones avatar Oct 27 '17 11:10 titaniumbones

Should it be part of the readme or a separate INSTALLATION.md file?

KrzysztofMadejski avatar Oct 27 '17 11:10 KrzysztofMadejski

we're putting install instructions in README for now, so start with that and if it gets to long we cna move it out into its own doc. Thank you!!

On 10/27/2017 07:25 AM, Krzysiek Madejski wrote:

Should it be part of the readme or a separate INSTALLATION.md file?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/datatogether/sentry/issues/7#issuecomment-339945760, or mute the thread https://github.com/notifications/unsubscribe-auth/AAWPNGQy5o-jlhHZqzQH4tj2E_c6IvS8ks5swb2sgaJpZM4N1WM3.

titaniumbones avatar Oct 27 '17 11:10 titaniumbones

@titaniumbones I'm missing the information how to configure scraper so it actually scrapes anything.

KrzysztofMadejski avatar Oct 27 '17 15:10 KrzysztofMadejski

ok cool we're hoping to get to this about 2-3 hours from now.

@b5 let's try to do this today.

titaniumbones avatar Oct 27 '17 15:10 titaniumbones

PR #48 has improved usage instructions

dcwalk avatar Oct 28 '17 13:10 dcwalk